docs(mkdocs): add file import via snippet

faust-streaming · Mar 12, 2024 · 0a84305 · 0a84305
1 parent 57e06f4
commit 0a84305
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 2 deletions.
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -0,0 +1 @@
+--8<-- "CHANGELOG.md"
diff --git a/docs/contributing.md b/docs/contributing.md
@@ -0,0 +1 @@
+--8<-- "CONTRIBUTING.md"
diff --git a/docs/example-service.md b/docs/example-service.md
@@ -0,0 +1,3 @@
+```python title="Example Service"
+--8<-- "examples/service.py"
+```
diff --git a/docs/example-webapp.md b/docs/example-webapp.md
@@ -0,0 +1,3 @@
+```python title="Example Webapp"
+--8<-- "examples/webapp.py"
+```
diff --git a/examples/tutorial.py → examples/webapp.py b/examples/tutorial.py → examples/webapp.py
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -32,8 +32,13 @@ repo_url: https://github.com/faust-streaming/mode
 
 nav:
   - Mode:
-    - Introduction: 'index.md'
-    - Creating a Service: 'creating-service.md'
+    - Introduction: index.md
+    - Creating a Service: creating-service.md
+    - Examples:
+      - Service: example-service.md
+      - Web app: example-webapp.md
+    - Developing:
+      - Contributing Guide: contributing.md
   - References:
     - 'Mode':
       - mode.services: references/mode.services.md
@@ -78,6 +83,7 @@ nav:
       - mode.utils.trees: references/mode.utils.trees.md
       - mode.utils.types.graphs: references/mode.utils.types.graphs.md
       - mode.utils.types.trees: references/mode.utils.types.trees.md
+  - Changelog: changelog.md
 markdown_extensions:
   - pymdownx.highlight
   - pymdownx.inlinehilite