nodemcu-firmware/mkdocs.yml

site_name: NodeMCU Documentation
site_description: Description of the NodeMCU documentation
repo_url: https://github.com/nodemcu/nodemcu-firmware/

theme:
  name: "readthedocs"
  hljs_languages:
    - lua
strict: false

markdown_extensions:
  #http://pythonhosted.org/Markdown/extensions/admonition.html
  - admonition:
  - toc:
      permalink: True

#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

nav:
  - Overview: 'index.md'
  - Basics:
      - Building the firmware: 'build.md'
      - Flashing the firmware: 'flash.md'
      - Uploading code: 'upload.md'
      - JTAG debugging: 'debug.md'
      - Support: 'support.md'
  - Reference:
      - NodeMCU Language Reference Manual: 'nodemcu-lrm.md'
      - Programming in NodeMCU: 'nodemcu-pil.md'
  - FAQs:
      - Lua Developer FAQ: 'lua-developer-faq.md'
      - Extension Developer FAQ: 'extn-developer-faq.md'
  - Whitepapers:
      - Lua 5.3 Support: 'lua53.md'
      - Lua Flash Store (LFS): 'lfs.md'
      - Filesystem on SD card: 'sdcard.md'
  - C Modules:
      - 'adc': 'modules/adc.md'
      - 'bit': 'modules/bit.md'
      - 'bthci': 'modules/bthci.md'
      - 'can': 'modules/can.md'
      - 'console': 'modules/console.md'
      - 'crypto': 'modules/crypto.md'
      - 'dac': 'modules/dac.md'
      - 'dht': 'modules/dht.md'
      - 'encoder': 'modules/encoder.md'
      - 'eromfs': 'modules/eromfs.md'
      - 'espnow': 'modules/espnow.md'
      - 'eth': 'modules/eth.md'
      - 'file': 'modules/file.md'
      - 'gpio': 'modules/gpio.md'
      - 'heaptrace': 'modules/heaptrace.md'
      - 'http': 'modules/http.md'
      - 'httpd': 'modules/httpd.md'
      - 'i2c': 'modules/i2c.md'
      - 'i2s': 'modules/i2s.md'
      - 'ledc': 'modules/ledc.md'
      - 'mdns': 'modules/mdns.md'
      - 'mqtt': 'modules/mqtt.md'
      - 'net': 'modules/net.md'
      - 'node': 'modules/node.md'
      - 'ota': 'modules/otaupgrade.md'
      - 'ow (1-Wire)': 'modules/ow.md'
      - 'pipe':         'modules/pipe.md'
      - 'pulsecnt': 'modules/pulsecnt.md'
      - 'qrcodegen': 'modules/qrcodegen.md'
      - 'rmt': 'modules/rmt.md'
      - 'rtcmem': 'modules/rtcmem.md'
      - 'sdmmc': 'modules/sdmmc.md'
      - 'sigma delta': 'modules/sigma-delta.md'
      - 'sjson': 'modules/sjson.md'
      - 'sodium': 'modules/sodium.md'
      - 'spi': 'modules/spi.md'
      - 'struct': 'modules/struct.md'
      - 'time': 'modules/time.md'
      - 'tmr': 'modules/tmr.md'
      - 'touch': 'modules/touch.md'
      - 'u8g2': 'modules/u8g2.md'
      - 'uart': 'modules/uart.md'
      - 'ucg': 'modules/ucg.md'
      - 'wifi': 'modules/wifi.md'
      - 'ws2812': 'modules/ws2812.md'
Add first MkDocs skeleton 2015-12-04 23:12:28 +01:00			`site_name: NodeMCU Documentation`
			`site_description: Description of the NodeMCU documentation`
Playing with page structure 2015-12-05 01:05:14 +01:00			`repo_url: https://github.com/nodemcu/nodemcu-firmware/`
Fix blockquote style and admonition 2015-12-14 21:41:06 +01:00
unbreak mkdocs build 2018-10-07 15:59:04 +02:00			`theme:`
			`name: "readthedocs"`
Update RTD MkDocs (#3457) * Modernize docs * Remove old style hacks * Add comment 2021-08-16 07:27:56 +02:00			`hljs_languages:`
			`- lua`
Re-organize documentation Drop support for localized content, #2213 Restructure some content to match more closely what we have in master, #2542 2019-01-13 21:19:03 +01:00			`strict: false`
Change ordering of properties 2015-12-17 17:33:43 +01:00
Playing with page structure 2015-12-05 01:05:14 +01:00			`markdown_extensions:`
Update RTD MkDocs (#3457) * Modernize docs * Remove old style hacks * Add comment 2021-08-16 07:27:56 +02:00			`#http://pythonhosted.org/Markdown/extensions/admonition.html`
			`- admonition:`
			`- toc:`
			`permalink: True`
Fix blockquote style and admonition 2015-12-14 21:41:06 +01:00
Add config changes to to RTD behavior 2015-12-27 23:51:54 +01:00			`#see http://mkdocs.readthedocs.org/en/latest/user-guide/styling-your-docs/#customising-a-theme`
Add config changes to to RTD behavior 2015-12-27 23:49:11 +01:00			`extra_css:`
Update RTD MkDocs (#3457) * Modernize docs * Remove old style hacks * Add comment 2021-08-16 07:27:56 +02:00			`- css/extra.css`
Add config changes to to RTD behavior 2015-12-27 23:51:54 +01:00			`extra_javascript:`
Update RTD MkDocs (#3457) * Modernize docs * Remove old style hacks * Add comment 2021-08-16 07:27:56 +02:00			`- js/extra.js`
Add config changes to to RTD behavior 2015-12-27 23:49:11 +01:00
Bump MkDocs to latest 2024-02-18 22:14:27 +01:00			`nav:`
Update RTD MkDocs (#3457) * Modernize docs * Remove old style hacks * Add comment 2021-08-16 07:27:56 +02:00			`- Overview: 'index.md'`
			`- Basics:`
			`- Building the firmware: 'build.md'`
			`- Flashing the firmware: 'flash.md'`
			`- Uploading code: 'upload.md'`
			`- JTAG debugging: 'debug.md'`
			`- Support: 'support.md'`
Merge branch 'dev-esp32-idf4-lua53' into dev-esp32-idf4 2021-08-24 02:42:43 +02:00			`- Reference:`
			`- NodeMCU Language Reference Manual: 'nodemcu-lrm.md'`
			`- Programming in NodeMCU: 'nodemcu-pil.md'`
Update RTD MkDocs (#3457) * Modernize docs * Remove old style hacks * Add comment 2021-08-16 07:27:56 +02:00			`- FAQs:`
			`- Lua Developer FAQ: 'lua-developer-faq.md'`
			`- Extension Developer FAQ: 'extn-developer-faq.md'`
			`- Whitepapers:`
Merge branch 'dev-esp32-idf4-lua53' into dev-esp32-idf4 2021-08-24 02:42:43 +02:00			`- Lua 5.3 Support: 'lua53.md'`
			`- Lua Flash Store (LFS): 'lfs.md'`
Update RTD MkDocs (#3457) * Modernize docs * Remove old style hacks * Add comment 2021-08-16 07:27:56 +02:00			`- Filesystem on SD card: 'sdcard.md'`
			`- C Modules:`
			`- 'adc': 'modules/adc.md'`
			`- 'bit': 'modules/bit.md'`
			`- 'bthci': 'modules/bthci.md'`
			`- 'can': 'modules/can.md'`
Refactor to clean up and fix console handling (#3666) * Refactor into new 'console' module. A breaking change, but should finally see us move away from the chronic edge cases and inconsistent behaviour we have while trying to shoe-horn the usb-serial-jtag and cdc-acm consoles into uart behaviour and assumptions. * Fix and document console.write() Added example on using framed data transmission over the console. * fixup uart examples * Add workaround for silently dropped console output. * Add file upload helper script for console module. Plus, it can serve as a reference for any IDEs which may need/want updating. * Fixup really silly copy/paste error. * Make upload-file.py work better on CDC-ACM console. * Updated console module doc with CDC-ACM info. * Load file in binary mode in upload-file.py. 2024-12-10 01:08:10 +01:00			`- 'console': 'modules/console.md'`
Update RTD MkDocs (#3457) * Modernize docs * Remove old style hacks * Add comment 2021-08-16 07:27:56 +02:00			`- 'crypto': 'modules/crypto.md'`
			`- 'dac': 'modules/dac.md'`
			`- 'dht': 'modules/dht.md'`
			`- 'encoder': 'modules/encoder.md'`
Add support for using multiple memory slots in rmt setup (#3568) * Add support for using multiple memory slots in rmt setup * Fix a crash when stopping an RMT receiver * Add missing docs to the mkdocs 2024-02-02 02:31:56 +01:00			`- 'eromfs': 'modules/eromfs.md'`
Added espnow module with documentation. 2024-03-07 07:50:31 +01:00			`- 'espnow': 'modules/espnow.md'`
Update RTD MkDocs (#3457) * Modernize docs * Remove old style hacks * Add comment 2021-08-16 07:27:56 +02:00			`- 'eth': 'modules/eth.md'`
			`- 'file': 'modules/file.md'`
			`- 'gpio': 'modules/gpio.md'`
Added heaptrace module. 2021-09-16 05:54:55 +02:00			`- 'heaptrace': 'modules/heaptrace.md'`
Update RTD MkDocs (#3457) * Modernize docs * Remove old style hacks * Add comment 2021-08-16 07:27:56 +02:00			`- 'http': 'modules/http.md'`
IDF web server module (#3502) * Added httpd module. Lua-interface to the standard esp_http_server component. * Added eromfs module. 2022-03-05 03:51:54 +01:00			`- 'httpd': 'modules/httpd.md'`
Update RTD MkDocs (#3457) * Modernize docs * Remove old style hacks * Add comment 2021-08-16 07:27:56 +02:00			`- 'i2c': 'modules/i2c.md'`
			`- 'i2s': 'modules/i2s.md'`
			`- 'ledc': 'modules/ledc.md'`
Add mDNS module. 2024-12-12 07:47:06 +01:00			`- 'mdns': 'modules/mdns.md'`
Update RTD MkDocs (#3457) * Modernize docs * Remove old style hacks * Add comment 2021-08-16 07:27:56 +02:00			`- 'mqtt': 'modules/mqtt.md'`
			`- 'net': 'modules/net.md'`
			`- 'node': 'modules/node.md'`
			`- 'ota': 'modules/otaupgrade.md'`
			`- 'ow (1-Wire)': 'modules/ow.md'`
Merge branch 'dev-esp32-idf4-lua53' into dev-esp32-idf4 2021-08-24 02:42:43 +02:00			`- 'pipe': 'modules/pipe.md'`
Update RTD MkDocs (#3457) * Modernize docs * Remove old style hacks * Add comment 2021-08-16 07:27:56 +02:00			`- 'pulsecnt': 'modules/pulsecnt.md'`
			`- 'qrcodegen': 'modules/qrcodegen.md'`
Add support for using multiple memory slots in rmt setup (#3568) * Add support for using multiple memory slots in rmt setup * Fix a crash when stopping an RMT receiver * Add missing docs to the mkdocs 2024-02-02 02:31:56 +01:00			`- 'rmt': 'modules/rmt.md'`
Add missing doc link to rtcmem module. As pointed out by Marcel, thank you! 2024-03-27 03:51:31 +01:00			`- 'rtcmem': 'modules/rtcmem.md'`
Update RTD MkDocs (#3457) * Modernize docs * Remove old style hacks * Add comment 2021-08-16 07:27:56 +02:00			`- 'sdmmc': 'modules/sdmmc.md'`
			`- 'sigma delta': 'modules/sigma-delta.md'`
			`- 'sjson': 'modules/sjson.md'`
			`- 'sodium': 'modules/sodium.md'`
			`- 'spi': 'modules/spi.md'`
			`- 'struct': 'modules/struct.md'`
			`- 'time': 'modules/time.md'`
			`- 'tmr': 'modules/tmr.md'`
			`- 'touch': 'modules/touch.md'`
			`- 'u8g2': 'modules/u8g2.md'`
			`- 'uart': 'modules/uart.md'`
			`- 'ucg': 'modules/ucg.md'`
			`- 'wifi': 'modules/wifi.md'`
			`- 'ws2812': 'modules/ws2812.md'`