mkdocs.yml 1.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445
  1. site_name: NodeMCU Documentation
  2. site_description: Description of the NodeMCU documentation
  3. repo_url: https://github.com/nodemcu/nodemcu-firmware/
  4. theme: readthedocs
  5. strict: true
  6. markdown_extensions:
  7. #http://pythonhosted.org/Markdown/extensions/admonition.html
  8. - admonition:
  9. - toc:
  10. permalink: True
  11. #requird due to https://github.com/rtfd/readthedocs.org/issues/1313
  12. #see http://mkdocs.readthedocs.org/en/latest/user-guide/styling-your-docs/#customising-a-theme
  13. extra_css:
  14. - css/extra.css
  15. extra_javascript:
  16. - js/extra.js
  17. site_favicon: img/favicon.png
  18. pages:
  19. - Overview: 'index.md'
  20. - English:
  21. - Building the firmware: 'en/build.md'
  22. - Flashing the firmware: 'en/flash.md'
  23. - Uploading code: 'en/upload.md'
  24. - FAQs:
  25. - Lua Developer FAQ: 'en/lua-developer-faq.md'
  26. - Extension Developer FAQ: 'en/extn-developer-faq.md'
  27. - Support: 'en/support.md'
  28. - Modules:
  29. - 'bit': 'en/modules/bit.md'
  30. - 'bthci': 'en/modules/bthci.md'
  31. - 'file': 'en/modules/file.md'
  32. - 'i2c': 'en/modules/i2c.md'
  33. - 'node': 'en/modules/node.md'
  34. - 'ow (1-Wire)': 'en/modules/ow.md'
  35. - 'sigma delta': 'en/modules/sigma-delta.md'
  36. - 'struct': 'en/modules/struct.md'
  37. - 'tmr': 'en/modules/tmr.md'
  38. - 'uart': 'en/modules/uart.md'
  39. - 'wifi': 'en/modules/wifi.md'