diff --git a/docs/index.md b/docs/index.md index da37213a..2a58d418 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,6 @@ -# Welcome to MkDocs +# Welcome to NodeMCU -For full documentation visit [mkdocs.org](http://mkdocs.org). +NodeMCU is a Lua based firmware for the ESP8266 WiFi SOC from Espressif. ## Commands diff --git a/mkdocs.yml b/mkdocs.yml index a49066f4..11c92229 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,5 +1,12 @@ site_name: NodeMCU Documentation site_description: Description of the NodeMCU documentation theme: readthedocs +repo_url: https://github.com/nodemcu/nodemcu-firmware/ +markdown_extensions: +- toc: + permalink: True pages: -- ['index.md', 'Index'] \ No newline at end of file +- Home: 'index.md' +- 'build.md' +- Modules: + - 'node': 'modules/node.md' \ No newline at end of file