Init mkdocs

luozhouyang · Jan 16, 2024 · 6c33e2a · 6c33e2a
1 parent 8a9ddf2
commit 6c33e2a
Show file tree

Hide file tree

Showing 4 changed files with 1,047 additions and 1 deletion.
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,2 @@
+site_name: Melody
+theme: material