mkdocs.yml 1.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  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. - Filesystem on SD card: 'en/sdcard.md'
  24. - Uploading code: 'en/upload.md'
  25. - FAQs:
  26. - Lua Developer FAQ: 'en/lua-developer-faq.md'
  27. - Extension Developer FAQ: 'en/extn-developer-faq.md'
  28. - Support: 'en/support.md'
  29. - Modules:
  30. - 'adc': 'en/modules/adc.md'
  31. - 'bit': 'en/modules/bit.md'
  32. - 'bthci': 'en/modules/bthci.md'
  33. - 'can': 'en/modules/can.md'
  34. - 'dht': 'en/modules/dht.md'
  35. - 'file': 'en/modules/file.md'
  36. - 'gpio': 'en/modules/gpio.md'
  37. - 'i2c': 'en/modules/i2c.md'
  38. - 'ledc': 'en/modules/ledc.md'
  39. - 'net': 'en/modules/net.md'
  40. - 'node': 'en/modules/node.md'
  41. - 'ow (1-Wire)': 'en/modules/ow.md'
  42. - 'sdmmc': 'en/modules/sdmmc.md'
  43. - 'sigma delta': 'en/modules/sigma-delta.md'
  44. - 'spi': 'en/modules/spi.md'
  45. - 'struct': 'en/modules/struct.md'
  46. - 'tmr': 'en/modules/tmr.md'
  47. - 'u8g2': 'en/modules/u8g2.md'
  48. - 'u8g2 Display': 'en/modules/u8g2_disp.md'
  49. - 'uart': 'en/modules/uart.md'
  50. - 'wifi': 'en/modules/wifi.md'
  51. - 'ws2812': 'en/modules/ws2812.md'