nodemcu-firmware/docs/index.md

# NodeMCU Documentation

NodeMCU is an [eLua](http://www.eluaproject.net/) based firmware for the [ESP32](http://espressif.com/en/products/hardware/esp32/overview) and [ESP8266 WiFi SOC from Espressif](http://espressif.com/en/products/esp8266/).  The NodeMCU *firmware* is a companion project to the popular [NodeMCU dev kits](https://github.com/nodemcu/nodemcu-devkit-v1.0), ready-made open source development boards with ESP8266-12E chips.

Support for the new [ESP32 WiFi/BlueTooth SOC from Espressif](http://www.espressif.com/en/products/hardware/esp32/overview) is under way.

## Up-To-Date Documentation
At the moment the only up-to-date documentation maintained by the current NodeMCU team is in English. It is part of the source code repository (`/docs` subfolder) and kept in sync with the code.

We encourage you to help transferring the outdated translations (see below) into the repository.

## Outdated And Sparse Documentation
The following translations are based on outdated documentation, use them with caution. The links point to the [NodeMCU wiki on GitHub](https://github.com/nodemcu/nodemcu-firmware/wiki).

- Chinese, [中文](https://github.com/nodemcu/nodemcu-firmware/wiki/nodemcu_api_cn)
- Russian, [русский](https://github.com/nodemcu/nodemcu-firmware/wiki/nodemcu_api_ru)
- Spanish, [español](https://github.com/nodemcu/nodemcu-firmware/wiki/nodemcu_api_es)
Proper structure for modules and more content 2015-12-13 14:43:52 +01:00			`# NodeMCU Documentation`
Add first MkDocs skeleton 2015-12-04 23:12:28 +01:00
Fix link to ESP32 hardware page (#2196) 2017-12-17 01:03:05 +01:00			`NodeMCU is an [eLua](http://www.eluaproject.net/) based firmware for the [ESP32](http://espressif.com/en/products/hardware/esp32/overview) and [ESP8266 WiFi SOC from Espressif](http://espressif.com/en/products/esp8266/). The NodeMCU firmware is a companion project to the popular [NodeMCU dev kits](https://github.com/nodemcu/nodemcu-devkit-v1.0), ready-made open source development boards with ESP8266-12E chips.`
Add first MkDocs skeleton 2015-12-04 23:12:28 +01:00
Removed all currently-unused code & docs. Heading towards having only ESP32-aware/capable code in this branch. 2016-09-21 05:47:44 +02:00			`Support for the new [ESP32 WiFi/BlueTooth SOC from Espressif](http://www.espressif.com/en/products/hardware/esp32/overview) is under way.`

Final polishing on several pages 2016-01-16 23:11:40 +01:00			`## Up-To-Date Documentation`
fix wrong link to index.md 2018-10-07 16:04:12 +02:00			At the moment the only up-to-date documentation maintained by the current NodeMCU team is in English. It is part of the source code repository (`/docs` subfolder) and kept in sync with the code.
Add first MkDocs skeleton 2015-12-04 23:12:28 +01:00
Final polishing on several pages 2016-01-16 23:11:40 +01:00			`We encourage you to help transferring the outdated translations (see below) into the repository.`
Add first MkDocs skeleton 2015-12-04 23:12:28 +01:00
Final polishing on several pages 2016-01-16 23:11:40 +01:00			`## Outdated And Sparse Documentation`
			`The following translations are based on outdated documentation, use them with caution. The links point to the [NodeMCU wiki on GitHub](https://github.com/nodemcu/nodemcu-firmware/wiki).`
Add first MkDocs skeleton 2015-12-04 23:12:28 +01:00
Final polishing on several pages 2016-01-16 23:11:40 +01:00			`- Chinese, [中文](https://github.com/nodemcu/nodemcu-firmware/wiki/nodemcu_api_cn)`
			`- Russian, [русский](https://github.com/nodemcu/nodemcu-firmware/wiki/nodemcu_api_ru)`
Removed all currently-unused code & docs. Heading towards having only ESP32-aware/capable code in this branch. 2016-09-21 05:47:44 +02:00			`- Spanish, [español](https://github.com/nodemcu/nodemcu-firmware/wiki/nodemcu_api_es)`