mkdocs

BDadmehr0 · Nov 11, 2024 · f02973a · f02973a
1 parent a7584c5
commit f02973a
Show file tree

Hide file tree

Showing 62 changed files with 14,261 additions and 0 deletions.
diff --git a/1/appetite.md → docs/1/appetite.md b/1/appetite.md → docs/1/appetite.md
diff --git a/2/interpreter.md → docs/2/interpreter.md b/2/interpreter.md → docs/2/interpreter.md
diff --git a/3/introduction.md → docs/3/introduction.md b/3/introduction.md → docs/3/introduction.md
diff --git a/4/controlflow.md → docs/4/controlflow.md b/4/controlflow.md → docs/4/controlflow.md
diff --git a/5/datastructures.md → docs/5/datastructures.md b/5/datastructures.md → docs/5/datastructures.md
diff --git a/6/modules.md → docs/6/modules.md b/6/modules.md → docs/6/modules.md
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,17 @@
+# Welcome to MkDocs
+
+For full documentation visit [mkdocs.org](https://www.mkdocs.org).
+
+## Commands
+
+* `mkdocs new [dir-name]` - Create a new project.
+* `mkdocs serve` - Start the live-reloading docs server.
+* `mkdocs build` - Build the documentation site.
+* `mkdocs -h` - Print help message and exit.
+
+## Project layout
+
+    mkdocs.yml    # The configuration file.
+    docs/
+        index.md  # The documentation homepage.
+        ...       # Other markdown pages, images and other files.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,22 @@
+site_name: My Documentation Site
+
+# You can also specify a description or other metadata.
+site_description: A simple static site for your documentation.
+site_author: Your Name
+
+# Navigation menu
+nav:
+  - Home: index.md
+  - Appetite: 1/appetite.md
+  - Interpreter: 2/interpreter.md
+  - Introduction: 3/introduction.md
+  - Control Flow: 4/controlflow.md
+  - Data Structures: 5/datastructures.md
+  - Modules: 6/modules.md
+  - Contributing: CONTRIBUTING.md
+  - License: LICENSE.md
+
+# The theme used to render the docs
+theme:
+  name: 'material'
+