From b736f701477928c6f6e4a22994c02a007f16fc17 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marcel=20St=C3=B6r?= Date: Fri, 4 Dec 2015 23:12:28 +0100 Subject: [PATCH] Add first MkDocs skeleton --- docs/index.md | 17 +++++++++++++++++ mkdocs.yml | 5 +++++ 2 files changed, 22 insertions(+) create mode 100644 docs/index.md create mode 100644 mkdocs.yml diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 00000000..da37213a --- /dev/null +++ b/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. diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 00000000..a49066f4 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,5 @@ +site_name: NodeMCU Documentation +site_description: Description of the NodeMCU documentation +theme: readthedocs +pages: +- ['index.md', 'Index'] \ No newline at end of file