Browse Source

Add mkdocs doc skeletton

Jocelyn Delande 9 years ago
parent
commit
d1eef91f8f
3 changed files with 20 additions and 0 deletions
  1. 17 0
      docs/docs/index.md
  2. 2 0
      docs/docs/test.md
  3. 1 0
      docs/mkdocs.yml

+ 17 - 0
docs/docs/index.md

@@ -0,0 +1,17 @@
+# Welcome to MkDocs
+
+For full documentation visit [mkdocs.org](http://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 help` - Print this help message.
+
+## Project layout
+
+    mkdocs.yml    # The configuration file.
+    docs/
+        index.md  # The documentation homepage.
+        ...       # Other markdown pages, images and other files.

+ 2 - 0
docs/docs/test.md

@@ -0,0 +1,2 @@
+Coucou
+======

+ 1 - 0
docs/mkdocs.yml

@@ -0,0 +1 @@
+site_name: My Docs