mkdocs.yml 5.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144
  1. site_name: NodeMCU Documentation
  2. site_description: Description of the NodeMCU documentation
  3. repo_url: https://github.com/nodemcu/nodemcu-firmware/
  4. theme:
  5. name: "readthedocs"
  6. hljs_languages:
  7. - lua
  8. strict: false #Allows to build and test documentation in local environment where some links are unreachable
  9. # Uncomment the line below to build docs to be used locally; site/index.html
  10. # will then be the root of a locally-linked documentation tree.
  11. # use_directory_urls: false
  12. markdown_extensions:
  13. #http://pythonhosted.org/Markdown/extensions/admonition.html
  14. - admonition:
  15. - toc:
  16. permalink: True
  17. #required due to https://github.com/rtfd/readthedocs.org/issues/1313
  18. #see http://mkdocs.readthedocs.org/en/latest/user-guide/styling-your-docs/#customising-a-theme
  19. extra_css:
  20. - css/extra.css
  21. extra_javascript:
  22. - js/extra.js
  23. pages:
  24. - Overview: 'index.md'
  25. - Basics:
  26. - Getting started: 'getting-started.md'
  27. - Building the firmware: 'build.md'
  28. - Flashing the firmware: 'flash.md'
  29. - Uploading code: 'upload.md'
  30. - Compiling code: 'compiling.md'
  31. - Support: 'support.md'
  32. - Reference:
  33. - NodeMCU Language Reference Manual: 'nodemcu-lrm.md'
  34. - Programming in NodeMCU: 'nodemcu-pil.md'
  35. - FAQs:
  36. - Lua Developer FAQ: 'lua-developer-faq.md'
  37. - Extension Developer FAQ: 'extn-developer-faq.md'
  38. - Hardware FAQ: 'hardware-faq.md'
  39. - Whitepapers:
  40. - Lua 5.3 Support: 'lua53.md'
  41. - Lua Flash Store (LFS): 'lfs.md'
  42. - Lua Compact Debug (LCD): 'lcd.md'
  43. - Filesystem on SD card: 'sdcard.md'
  44. - Internal filesystem: 'spiffs.md'
  45. - Lua Modules:
  46. - 'Lua modules directory': 'lua-modules/README.md'
  47. - 'bh1750': 'lua-modules/bh1750.md'
  48. - 'bme280': 'lua-modules/bme280.md'
  49. - 'cohelper': 'lua-modules/cohelper.md'
  50. - 'ds18b20': 'lua-modules/ds18b20.md'
  51. - 'ds3231': 'lua-modules/ds3231.md'
  52. - 'fifo': 'lua-modules/fifo.md'
  53. - 'fifosock': 'lua-modules/fifosock.md'
  54. - 'file_lfs': 'lua-modules/file_lfs.md'
  55. - 'ftpserver': 'lua-modules/ftpserver.md'
  56. - 'gossip': 'lua-modules/gossip.md'
  57. - 'hdc1000': 'lua-modules/hdc1000.md'
  58. - 'httpserver': 'lua-modules/httpserver.md'
  59. - 'imap': 'lua-modules/imap.md'
  60. - 'liquidcrystal': 'lua-modules/liquidcrystal.md'
  61. - 'lm92': 'lua-modules/lm92.md'
  62. - 'mcp23008': 'lua-modules/mcp23008.md'
  63. - 'mcp23017': 'lua-modules/mcp23017.md'
  64. - 'redis': 'lua-modules/redis.md'
  65. - 'telnet': 'lua-modules/telnet.md'
  66. - 'yeelink': 'lua-modules/yeelink.md'
  67. - C Modules:
  68. - 'adc': 'modules/adc.md'
  69. - 'ads1115': 'modules/ads1115.md'
  70. - 'adxl345': 'modules/adxl345.md'
  71. - 'am2320': 'modules/am2320.md'
  72. - 'apa102': 'modules/apa102.md'
  73. - 'bit': 'modules/bit.md'
  74. - 'bloom': 'modules/bloom.md'
  75. - 'bme280': 'modules/bme280.md'
  76. - 'bme280_math': 'modules/bme280_math.md'
  77. - 'bme680': 'modules/bme680.md'
  78. - 'bmp085': 'modules/bmp085.md'
  79. - 'cjson': 'modules/cjson.md'
  80. - 'coap': 'modules/coap.md'
  81. - 'color-utils': 'modules/color-utils.md'
  82. - 'cron': 'modules/cron.md'
  83. - 'crypto': 'modules/crypto.md'
  84. - 'dcc': 'modules/dcc.md'
  85. - 'dht': 'modules/dht.md'
  86. - 'encoder': 'modules/encoder.md'
  87. - 'enduser setup / captive portal / WiFi manager': 'modules/enduser-setup.md'
  88. - 'file': 'modules/file.md'
  89. - 'gdbstub': 'modules/gdbstub.md'
  90. - 'gpio': 'modules/gpio.md'
  91. - 'hdc1080': 'modules/hdc1080.md'
  92. - 'hmc5883l': 'modules/hmc5883l.md'
  93. - 'http': 'modules/http.md'
  94. - 'hx711': 'modules/hx711.md'
  95. - 'i2c': 'modules/i2c.md'
  96. - 'l3g4200d': 'modules/l3g4200d.md'
  97. - 'mcp4725': 'modules/mcp4725.md'
  98. - 'mdns': 'modules/mdns.md'
  99. - 'mqtt': 'modules/mqtt.md'
  100. - 'net': 'modules/net.md'
  101. - 'node': 'modules/node.md'
  102. - 'ow (1-Wire)': 'modules/ow.md'
  103. - 'pcm': 'modules/pcm.md'
  104. - 'perf': 'modules/perf.md'
  105. - 'pipe': 'modules/pipe.md'
  106. - 'pixbuf': 'modules/pixbuf.md'
  107. - 'pwm': 'modules/pwm.md'
  108. - 'pwm2': 'modules/pwm2.md'
  109. - 'rfswitch': 'modules/rfswitch.md'
  110. - 'rotary': 'modules/rotary.md'
  111. - 'rtcfifo': 'modules/rtcfifo.md'
  112. - 'rtcmem': 'modules/rtcmem.md'
  113. - 'rtctime': 'modules/rtctime.md'
  114. - 'si7021': 'modules/si7021.md'
  115. - 'sigma delta': 'modules/sigma-delta.md'
  116. - 'sjson': 'modules/sjson.md'
  117. - 'sntp': 'modules/sntp.md'
  118. - 'softuart': 'modules/softuart.md'
  119. - 'somfy': 'modules/somfy.md'
  120. - 'spi': 'modules/spi.md'
  121. - 'struct': 'modules/struct.md'
  122. - 'switec': 'modules/switec.md'
  123. - 'tcs34725': 'modules/tcs34725.md'
  124. - 'tls': 'modules/tls.md'
  125. - 'tm1829': 'modules/tm1829.md'
  126. - 'tmr': 'modules/tmr.md'
  127. - 'tsl2561': 'modules/tsl2561.md'
  128. - 'u8g2': 'modules/u8g2.md'
  129. - 'uart': 'modules/uart.md'
  130. - 'ucg': 'modules/ucg.md'
  131. - 'websocket': 'modules/websocket.md'
  132. - 'wiegand': 'modules/wiegand.md'
  133. - 'wifi': 'modules/wifi.md'
  134. - 'wifi.monitor': 'modules/wifi_monitor.md'
  135. - 'wps': 'modules/wps.md'
  136. - 'ws2801': 'modules/ws2801.md'
  137. - 'ws2812': 'modules/ws2812.md'
  138. - 'ws2812-effects': 'modules/ws2812-effects.md'
  139. - 'xpt2046': 'modules/xpt2046.md'