nodemcu-firmware/mkdocs.yml

43 lines
1.2 KiB
YAML

site_name: NodeMCU Documentation
site_description: Description of the NodeMCU documentation
repo_url: https://github.com/nodemcu/nodemcu-firmware/
theme: readthedocs
strict: true
markdown_extensions:
#http://pythonhosted.org/Markdown/extensions/admonition.html
- admonition:
- toc:
permalink: True
#requird due to https://github.com/rtfd/readthedocs.org/issues/1313
#see http://mkdocs.readthedocs.org/en/latest/user-guide/styling-your-docs/#customising-a-theme
extra_css:
- css/extra.css
extra_javascript:
- js/extra.js
site_favicon: img/favicon.png
pages:
- Overview: 'index.md'
- English:
- Building the firmware: 'en/build.md'
- Uploading code: 'en/upload.md'
- FAQs:
- Lua Developer FAQ: 'en/lua-developer-faq.md'
- Extension Developer FAQ: 'en/extn-developer-faq.md'
- Support: 'en/support.md'
- Modules:
- 'bit': 'en/modules/bit.md'
- 'bthci': 'en/modules/bthci.md'
- 'file': 'en/modules/file.md'
- 'i2c': 'en/modules/i2c.md'
- 'node': 'en/modules/node.md'
- 'sigma delta': 'en/modules/sigma-delta.md'
- 'struct': 'en/modules/struct.md'
- 'uart': 'en/modules/uart.md'
- 'wifi': 'en/modules/wifi.md'