mkdocs.yml 3.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105
  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. pages:
  18. - Overview: 'index.md'
  19. - English:
  20. - Home: 'en/index.md'
  21. - Building the firmware: 'en/build.md'
  22. - Flashing the firmware: 'en/flash.md'
  23. - Internal filesystem notes: 'en/spiffs.md'
  24. - Filesystem on SD card: 'en/sdcard.md'
  25. - Uploading code: 'en/upload.md'
  26. - FAQs:
  27. - Lua Developer FAQ: 'en/lua-developer-faq.md'
  28. - Extension Developer FAQ: 'en/extn-developer-faq.md'
  29. - Hardware FAQ: 'en/hardware-faq.md'
  30. - Support: 'en/support.md'
  31. - Modules:
  32. - 'adc': 'en/modules/adc.md'
  33. - 'ads1115' : 'en/modules/ads1115.md'
  34. - 'adxl345': 'en/modules/adxl345.md'
  35. - 'am2320': 'en/modules/am2320.md'
  36. - 'apa102': 'en/modules/apa102.md'
  37. - 'bit': 'en/modules/bit.md'
  38. - 'bloom' : 'en/modules/bloom.md'
  39. - 'bme280': 'en/modules/bme280.md'
  40. - 'bme680': 'en/modules/bme680.md'
  41. - 'bmp085': 'en/modules/bmp085.md'
  42. - 'cjson': 'en/modules/cjson.md'
  43. - 'coap': 'en/modules/coap.md'
  44. - 'color-utils': 'en/modules/color-utils.md'
  45. - 'cron': 'en/modules/cron.md'
  46. - 'crypto': 'en/modules/crypto.md'
  47. - 'dht': 'en/modules/dht.md'
  48. - 'ds18b20': 'en/modules/ds18b20.md'
  49. - 'encoder': 'en/modules/encoder.md'
  50. - 'enduser setup': 'en/modules/enduser-setup.md'
  51. - 'file': 'en/modules/file.md'
  52. - 'gdbstub': 'en/modules/gdbstub.md'
  53. - 'gpio': 'en/modules/gpio.md'
  54. - 'hdc1080': 'en/modules/hdc1080.md'
  55. - 'hmc5883l': 'en/modules/hmc5883l.md'
  56. - 'http': 'en/modules/http.md'
  57. - 'hx711' : 'en/modules/hx711.md'
  58. - 'i2c' : 'en/modules/i2c.md'
  59. - 'l3g4200d' : 'en/modules/l3g4200d.md'
  60. - 'mcp4725': 'en/modules/mcp4725.md'
  61. - 'mdns': 'en/modules/mdns.md'
  62. - 'mqtt': 'en/modules/mqtt.md'
  63. - 'net': 'en/modules/net.md'
  64. - 'node': 'en/modules/node.md'
  65. - 'ow (1-Wire)': 'en/modules/ow.md'
  66. - 'pcm' : 'en/modules/pcm.md'
  67. - 'perf': 'en/modules/perf.md'
  68. - 'pwm' : 'en/modules/pwm.md'
  69. - 'rc' : 'en/modules/rc.md'
  70. - 'rfswitch' : 'en/modules/rfswitch.md'
  71. - 'rotary' : 'en/modules/rotary.md'
  72. - 'rtcfifo': 'en/modules/rtcfifo.md'
  73. - 'rtcmem': 'en/modules/rtcmem.md'
  74. - 'rtctime': 'en/modules/rtctime.md'
  75. - 'si7021' : 'en/modules/si7021.md'
  76. - 'sigma delta': 'en/modules/sigma-delta.md'
  77. - 'sjson': 'en/modules/sjson.md'
  78. - 'sntp': 'en/modules/sntp.md'
  79. - 'somfy': 'en/modules/somfy.md'
  80. - 'spi': 'en/modules/spi.md'
  81. - 'sqlite3': 'en/modules/sqlite3.md'
  82. - 'struct': 'en/modules/struct.md'
  83. - 'switec': 'en/modules/switec.md'
  84. - 'tcs34725': 'en/modules/tcs34725.md'
  85. - 'tls': 'en/modules/tls.md'
  86. - 'tm1829': 'en/modules/tm1829.md'
  87. - 'tmr': 'en/modules/tmr.md'
  88. - 'tsl2561': 'en/modules/tsl2561.md'
  89. - 'u8g': 'en/modules/u8g.md'
  90. - 'uart': 'en/modules/uart.md'
  91. - 'ucg': 'en/modules/ucg.md'
  92. - 'websocket': 'en/modules/websocket.md'
  93. - 'wifi': 'en/modules/wifi.md'
  94. - 'wifi.monitor': 'en/modules/wifi_monitor.md'
  95. - 'wps': 'en/modules/wps.md'
  96. - 'ws2801': 'en/modules/ws2801.md'
  97. - 'ws2812': 'en/modules/ws2812.md'
  98. - 'ws2812-effects': 'en/modules/ws2812-effects.md'
  99. - 'xpt2046': 'en/modules/xpt2046.md'
  100. #- Deutsch:
  101. # - Home: 'de/index.md'