MirrorSave
/
nodemcu-firmware
mirror of https://github.com/nodemcu/nodemcu-firmware.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
nodemcu-firmware/mkdocs.yml

142 lines
4.9 KiB
YAML
Raw Permalink Normal View History

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
Enable MkDocs strict mode again
2018-08-17 21:48:35 +02:00
theme:
name: "readthedocs"
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 22:01:57 +01:00
strict: false #Allows to build and test documentation in local environment where some links are unreachable
Change ordering of properties
2015-12-17 17:33:43 +01:00
Add hint about locally built docs Fixes #2868
2020-03-22 13:56:39 +01:00
# Uncomment the line below to build docs to be used locally; site/index.html
# will then be the root of a locally-linked documentation tree.
# use_directory_urls: false
Playing with page structure
2015-12-05 01:05:14 +01:00
markdown_extensions:
Change ordering of properties
2015-12-17 17:33:43 +01:00
#http://pythonhosted.org/Markdown/extensions/admonition.html
Fix blockquote style and admonition
2015-12-14 21:41:06 +01:00
- admonition:
Playing with page structure
2015-12-05 01:05:14 +01:00
- toc:
permalink: True
Fix blockquote style and admonition
2015-12-14 21:41:06 +01:00
Recreate and unify documentation for Lua modules (#2592) * Recreate and unify documentation for Lua modules * Fix typos in docs * Added/modified READMES to link to new documentation
2018-12-16 21:39:43 +01:00
#required due to https://github.com/rtfd/readthedocs.org/issues/1313
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:
- css/extra.css
Add config changes to to RTD behavior
2015-12-27 23:51:54 +01:00
extra_javascript:
Add config changes to to RTD behavior
2015-12-27 23:49:11 +01:00
- js/extra.js
Arggg, RTD went back to MkDocs < 1.x
2018-09-08 00:08:28 +02:00
pages:
Add experimental localized content structure
2015-12-27 23:32:07 +01:00
- Overview: 'index.md'
Add Getting Started page (#2487) - Added Marcel's Getting Started page - Added reference to getting-started.md - Incorporated review findings
2018-09-17 18:36:09 +02:00
- Basics:
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 22:01:57 +01:00
- Getting started: 'getting-started.md'
- Building the firmware: 'build.md'
- Flashing the firmware: 'flash.md'
- Uploading code: 'upload.md'
- Compiling code: 'compiling.md'
- Support: 'support.md'
Lua 5.1 / 5.3 alignment and document (#3193)
2020-08-22 18:41:02 +02:00
- Reference:
- NodeMCU Language Reference Manual: 'nodemcu-lrm.md'
- Programming in NodeMCU: 'nodemcu-pil.md'
Add Getting Started page (#2487) - Added Marcel's Getting Started page - Added reference to getting-started.md - Incorporated review findings
2018-09-17 18:36:09 +02:00
- FAQs:
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 22:01:57 +01:00
- Lua Developer FAQ: 'lua-developer-faq.md'
- Extension Developer FAQ: 'extn-developer-faq.md'
- Hardware FAQ: 'hardware-faq.md'
Add Getting Started page (#2487) - Added Marcel's Getting Started page - Added reference to getting-started.md - Incorporated review findings
2018-09-17 18:36:09 +02:00
- Whitepapers:
Lua 5.1 / 5.3 alignment and document (#3193)
2020-08-22 18:41:02 +02:00
- Lua 5.3 Support: 'lua53.md'
- Lua Flash Store (LFS): 'lfs.md'
- Lua Compact Debug (LCD): 'lcd.md'
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 22:01:57 +01:00
- Filesystem on SD card: 'sdcard.md'
- Internal filesystem: 'spiffs.md'
Recreate and unify documentation for Lua modules (#2592) * Recreate and unify documentation for Lua modules * Fix typos in docs * Added/modified READMES to link to new documentation
2018-12-16 21:39:43 +01:00
- Lua Modules:
Add page about Lua module directory Fixes #3034
2020-03-22 21:43:26 +01:00
- 'Lua modules directory': 'lua-modules/README.md'
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 22:01:57 +01:00
- 'bh1750': 'lua-modules/bh1750.md'
bme280 driver in Lua+C
2020-05-27 23:51:19 +02:00
- 'bme280': 'lua-modules/bme280.md'
Documentation fixes for pipe (#3041)
2020-02-18 12:41:31 +01:00
- 'cohelper': 'lua-modules/cohelper.md'
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 22:01:57 +01:00
- 'ds18b20': 'lua-modules/ds18b20.md'
- 'ds3231': 'lua-modules/ds3231.md'
A generic fifo and fifosock wrapper, under telnet and http server (#2650) * lua_modules/fifo: a generic queue & socket wrapper One occasionally wants a generic fifo, so here's a plausible implementation that's reasonably flexible in its usage. One possible consumer of this is a variant of TerryE's two-level fifo trick currently in the telnetd example. Factor that out to fifosock for more general use. * lua_examples/telnet: use factored out fifosock * lua_modules/http: improve implementation Switch to fifosock for in-order sending and waiting for everything to be sent before closing. Fix header callback by moving the invocation of the handler higher * fifosock: optimistically cork and delay tx If we just pushed a little bit of data into a fifosock that had idled, wait a tick (1 ms) before transmitting. Hopefully, this means that we let the rest of the system push more data in before we send the first packet. But in a high-throughput situation, where we are streaming data without idling the fifo, there won't be any additional delay and we'll coalesce during operation as usual. The fifosocktest mocks up enough of tmr for this to run, but assumes an arbitrarily slow processor. ;)
2019-02-16 13:51:40 +01:00
- 'fifo' : 'lua-modules/fifo.md'
- 'fifosock' : 'lua-modules/fifosock.md'
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 22:01:57 +01:00
- 'ftpserver': 'lua-modules/ftpserver.md'
Add Lua module for Gossip protocol (#3013)
2020-03-06 22:24:25 +01:00
- 'gossip': 'lua-modules/gossip.md'
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 22:01:57 +01:00
- 'hdc1000': 'lua-modules/hdc1000.md'
- 'httpserver': 'lua-modules/httpserver.md'
- 'imap': 'lua-modules/imap.md'
add LiquidCrystal lua module (#2974)
2020-04-18 16:35:14 +02:00
- 'liquidcrystal': 'lua-modules/liquidcrystal.md'
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 22:01:57 +01:00
- 'lm92': 'lua-modules/lm92.md'
- 'mcp23008': 'lua-modules/mcp23008.md'
Add mcp23017 Lua module (#3197)
2020-10-25 12:48:34 +01:00
- 'mcp23017': 'lua-modules/mcp23017.md'
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 22:01:57 +01:00
- 'redis': 'lua-modules/redis.md'
Make the telnet example an Lua module (#3133) Also update ftp server
2020-06-03 14:36:47 +02:00
- 'telnet': 'lua-modules/telnet.md'
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 22:01:57 +01:00
- 'yeelink': 'lua-modules/yeelink.md'
Recreate and unify documentation for Lua modules (#2592) * Recreate and unify documentation for Lua modules * Fix typos in docs * Added/modified READMES to link to new documentation
2018-12-16 21:39:43 +01:00
- C Modules:
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 22:01:57 +01:00
- 'adc': 'modules/adc.md'
- 'ads1115': 'modules/ads1115.md'
- 'adxl345' : 'modules/adxl345.md'
- 'am2320': 'modules/am2320.md'
- 'apa102': 'modules/apa102.md'
- 'bit': 'modules/bit.md'
- 'bloom' : 'modules/bloom.md'
- 'bme280': 'modules/bme280.md'
bme280 driver in Lua+C
2020-05-27 23:51:19 +02:00
- 'bme280_math': 'modules/bme280_math.md'
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 22:01:57 +01:00
- 'bme680': 'modules/bme680.md'
- 'bmp085': 'modules/bmp085.md'
- 'cjson': 'modules/cjson.md'
- 'coap': 'modules/coap.md'
- 'color-utils': 'modules/color-utils.md'
- 'cron': 'modules/cron.md'
- 'crypto': 'modules/crypto.md'
Add DCC decoder module (#2905)
2019-12-28 14:10:11 +01:00
- 'dcc': 'modules/dcc.md'
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 22:01:57 +01:00
- 'dht': 'modules/dht.md'
- 'encoder': 'modules/encoder.md'
Add aka titles
2019-06-22 22:53:37 +02:00
- 'enduser setup / captive portal / WiFi manager': 'modules/enduser-setup.md'
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 22:01:57 +01:00
- 'file': 'modules/file.md'
- 'gdbstub': 'modules/gdbstub.md'
- 'gpio': 'modules/gpio.md'
- 'hdc1080': 'modules/hdc1080.md'
- 'hmc5883l': 'modules/hmc5883l.md'
- 'http': 'modules/http.md'
- 'hx711' : 'modules/hx711.md'
- 'i2c' : 'modules/i2c.md'
- 'l3g4200d' : 'modules/l3g4200d.md'
- 'mcp4725': 'modules/mcp4725.md'
- 'mdns': 'modules/mdns.md'
- 'mqtt': 'modules/mqtt.md'
- 'net': 'modules/net.md'
- 'node': 'modules/node.md'
- 'ow (1-Wire)': 'modules/ow.md'
- 'pcm' : 'modules/pcm.md'
- 'perf': 'modules/perf.md'
Documentation fixes for pipe (#3041)
2020-02-18 12:41:31 +01:00
- 'pipe': 'modules/pipe.md'
Add pixbuf to doc index I am sure I have seen this in the PR at some time
2021-01-07 19:16:11 +01:00
- 'pixbuf': 'modules/pixbuf.md'
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 22:01:57 +01:00
- 'pwm' : 'modules/pwm.md'
Add pwm2 module (#2747)
2019-05-25 22:08:13 +02:00
- 'pwm2' : 'modules/pwm2.md'
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 22:01:57 +01:00
- 'rfswitch' : 'modules/rfswitch.md'
- 'rotary' : 'modules/rotary.md'
- 'rtcfifo': 'modules/rtcfifo.md'
- 'rtcmem': 'modules/rtcmem.md'
- 'rtctime': 'modules/rtctime.md'
- 'si7021' : 'modules/si7021.md'
- 'sigma delta': 'modules/sigma-delta.md'
- 'sjson': 'modules/sjson.md'
- 'sntp': 'modules/sntp.md'
Initial version of software UART C module (#2673)
2019-12-27 14:20:52 +01:00
- 'softuart': 'modules/softuart.md'
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 22:01:57 +01:00
- 'somfy': 'modules/somfy.md'
- 'spi': 'modules/spi.md'
- 'struct': 'modules/struct.md'
- 'switec': 'modules/switec.md'
- 'tcs34725': 'modules/tcs34725.md'
- 'tls': 'modules/tls.md'
- 'tm1829': 'modules/tm1829.md'
- 'tmr': 'modules/tmr.md'
- 'tsl2561': 'modules/tsl2561.md'
- 'u8g2': 'modules/u8g2.md'
- 'uart': 'modules/uart.md'
- 'ucg': 'modules/ucg.md'
- 'websocket': 'modules/websocket.md'
add wiegand module (#3203) * add wiegand module * minor tweaks to wiegand module * fix a whitespace error (tabs!!!!) * remove an unnecessary volatile qualifier
2020-10-19 02:05:31 +02:00
- 'wiegand': 'modules/wiegand.md'
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 22:01:57 +01:00
- 'wifi': 'modules/wifi.md'
- 'wifi.monitor': 'modules/wifi_monitor.md'
- 'wps': 'modules/wps.md'
- 'ws2801': 'modules/ws2801.md'
- 'ws2812': 'modules/ws2812.md'
- 'ws2812-effects': 'modules/ws2812-effects.md'
- 'xpt2046': 'modules/xpt2046.md'