nodemcu-firmware/mkdocs.yml

56 lines
1.9 KiB
YAML
Raw Normal View History

2015-12-04 23:12:28 +01:00
site_name: NodeMCU Documentation
site_description: Description of the NodeMCU documentation
2015-12-05 01:05:14 +01:00
repo_url: https://github.com/nodemcu/nodemcu-firmware/
2015-12-14 21:41:06 +01:00
2018-10-07 15:59:04 +02:00
theme:
name: "readthedocs"
strict: true
2015-12-17 17:33:43 +01:00
2015-12-05 01:05:14 +01:00
markdown_extensions:
2015-12-17 17:33:43 +01:00
#http://pythonhosted.org/Markdown/extensions/admonition.html
2015-12-14 21:41:06 +01:00
- admonition:
2015-12-05 01:05:14 +01:00
- toc:
permalink: True
2015-12-14 21:41:06 +01:00
2016-01-01 15:12:04 +01:00
#requird due to https://github.com/rtfd/readthedocs.org/issues/1313
2015-12-27 23:51:54 +01:00
#see http://mkdocs.readthedocs.org/en/latest/user-guide/styling-your-docs/#customising-a-theme
2015-12-27 23:49:11 +01:00
extra_css:
- css/extra.css
2015-12-27 23:51:54 +01:00
extra_javascript:
2015-12-27 23:49:11 +01:00
- js/extra.js
2015-12-04 23:12:28 +01:00
pages:
- Overview: 'index.md'
- English:
- Building the firmware: 'en/build.md'
- Flashing the firmware: 'en/flash.md'
2017-04-15 17:38:20 +02:00
- Filesystem on SD card: 'en/sdcard.md'
2016-01-16 23:11:40 +01:00
- Uploading code: 'en/upload.md'
- FAQs:
- Lua Developer FAQ: 'en/lua-developer-faq.md'
- Extension Developer FAQ: 'en/extn-developer-faq.md'
- Support: 'en/support.md'
- Modules:
2017-05-26 21:39:29 +02:00
- 'adc': 'en/modules/adc.md'
- 'bit': 'en/modules/bit.md'
- 'bthci': 'en/modules/bthci.md'
- 'can': 'en/modules/can.md'
- 'dht': 'en/modules/dht.md'
- 'file': 'en/modules/file.md'
- 'gpio': 'en/modules/gpio.md'
- 'i2c': 'en/modules/i2c.md'
- 'ledc': 'en/modules/ledc.md'
- 'mqtt': 'en/modules/mqtt.md'
2017-07-25 22:23:34 +02:00
- 'net': 'en/modules/net.md'
2017-05-26 21:39:29 +02:00
- 'node': 'en/modules/node.md'
- 'ow (1-Wire)': 'en/modules/ow.md'
- 'sdmmc': 'en/modules/sdmmc.md'
- 'sigma delta': 'en/modules/sigma-delta.md'
- 'spi': 'en/modules/spi.md'
- 'struct': 'en/modules/struct.md'
- 'tmr': 'en/modules/tmr.md'
- 'u8g2': 'en/modules/u8g2.md'
- 'uart': 'en/modules/uart.md'
- 'wifi': 'en/modules/wifi.md'
- 'ws2812': 'en/modules/ws2812.md'