Minor MkDocs fixes for 1.x compliance
This commit is contained in:
parent
3886d2c765
commit
186fcd7202
|
@ -2,7 +2,7 @@
|
||||||
|
|
||||||
NodeMCU is an open source [Lua](https://www.lua.org/) based firmware for the [ESP8266 WiFi SOC from Espressif](http://espressif.com/en/products/esp8266/) and uses an on-module flash-based [SPIFFS](https://github.com/pellepl/spiffs) file system. NodeMCU is implemented in C and is layered on the [Espressif NON-OS SDK](https://github.com/espressif/ESP8266_NONOS_SDK).
|
NodeMCU is an open source [Lua](https://www.lua.org/) based firmware for the [ESP8266 WiFi SOC from Espressif](http://espressif.com/en/products/esp8266/) and uses an on-module flash-based [SPIFFS](https://github.com/pellepl/spiffs) file system. NodeMCU is implemented in C and is layered on the [Espressif NON-OS SDK](https://github.com/espressif/ESP8266_NONOS_SDK).
|
||||||
|
|
||||||
The firmware was initially developed as is a companion project to the popular ESP8266-based [NodeMCU development modules]((https://github.com/nodemcu/nodemcu-devkit-v1.0)), but the project is now community-supported, and the firmware can now be run on _any_ ESP module.
|
The firmware was initially developed as is a companion project to the popular ESP8266-based [NodeMCU development modules](https://github.com/nodemcu/nodemcu-devkit-v1.0), but the project is now community-supported, and the firmware can now be run on _any_ ESP module.
|
||||||
|
|
||||||
## Programming Model
|
## Programming Model
|
||||||
The NodeMCU programming model is similar to that of [Node.js](https://en.wikipedia.org/wiki/Node.js), only in Lua. It is asynchronous and event-driven. Many functions, therefore, have parameters for callback functions. To give you an idea what a NodeMCU program looks like study the short snippets below. For more extensive examples have a look at the `/lua_examples` folder in the repository on GitHub.
|
The NodeMCU programming model is similar to that of [Node.js](https://en.wikipedia.org/wiki/Node.js), only in Lua. It is asynchronous and event-driven. Many functions, therefore, have parameters for callback functions. To give you an idea what a NodeMCU program looks like study the short snippets below. For more extensive examples have a look at the `/lua_examples` folder in the repository on GitHub.
|
||||||
|
|
|
@ -8,7 +8,7 @@ This FAQ does not aim to help you to learn to program or even how to program in
|
||||||
|
|
||||||
## What has changed since the first version of this FAQ?
|
## What has changed since the first version of this FAQ?
|
||||||
|
|
||||||
The [NodeMCU company](http://NodeMCU.com/index_en.html) was set up by [Zeroday](zeroday@nodemcu.com) to develop and to market a set of Lua firmware-based development boards which employ the Espressif ESP8266 SoC. The initial development of the firmware was done by Zeroday and a colleague, Vowstar, in-house with the firmware being first open-sourced on Github in late 2014. In mid-2015, Zeroday decided to open the firmware development to a wider group of community developers, so the core group of developers now comprises 6 community developers (including this author), and we are also supported by another dozen or so active contributors, and two NodeMCU originators.
|
The [NodeMCU company](http://NodeMCU.com/index_en.html) was set up by [Zeroday](mailto:zeroday@nodemcu.com) to develop and to market a set of Lua firmware-based development boards which employ the Espressif ESP8266 SoC. The initial development of the firmware was done by Zeroday and a colleague, Vowstar, in-house with the firmware being first open-sourced on Github in late 2014. In mid-2015, Zeroday decided to open the firmware development to a wider group of community developers, so the core group of developers now comprises 6 community developers (including this author), and we are also supported by another dozen or so active contributors, and two NodeMCU originators.
|
||||||
|
|
||||||
This larger active team has allowed us to address most of the outstanding issues present at the first version of this FAQ. These include:
|
This larger active team has allowed us to address most of the outstanding issues present at the first version of this FAQ. These include:
|
||||||
|
|
||||||
|
|
|
@ -1,5 +0,0 @@
|
||||||
# Getting started
|
|
||||||
## Obtain the firmware
|
|
||||||
[Build the firmware](build.html) or download it from ?
|
|
||||||
## Flash the firmware
|
|
||||||
There are a number of tools for flashing the firmware.
|
|
|
@ -1,4 +1,5 @@
|
||||||
var nodemcu = nodemcu || {};
|
var nodemcu = nodemcu || {};
|
||||||
|
|
||||||
(function () {
|
(function () {
|
||||||
'use strict';
|
'use strict';
|
||||||
//var languageCodeToNameMap = {en: 'English', de: 'Deutsch'};
|
//var languageCodeToNameMap = {en: 'English', de: 'Deutsch'};
|
||||||
|
@ -112,7 +113,7 @@ var nodemcu = nodemcu || {};
|
||||||
* replaces the relative path with an absolute path based on the selected branch.
|
* replaces the relative path with an absolute path based on the selected branch.
|
||||||
*/
|
*/
|
||||||
function replaceRelativeLinksWithStaticGitHubUrl() {
|
function replaceRelativeLinksWithStaticGitHubUrl() {
|
||||||
var relativePath = "../../../..";
|
var relativePath = isOnRtd() ? "../../../.." : "../../..";
|
||||||
var gitHubPath = "https://github.com/nodemcu/nodemcu-firmware/tree/" + determineSelectedBranch();
|
var gitHubPath = "https://github.com/nodemcu/nodemcu-firmware/tree/" + determineSelectedBranch();
|
||||||
var gitHubLinks = $("a[href^='" + relativePath + "']").each(function (index) {
|
var gitHubLinks = $("a[href^='" + relativePath + "']").each(function (index) {
|
||||||
var url = $(this).attr('href');
|
var url = $(this).attr('href');
|
||||||
|
@ -148,7 +149,7 @@ var nodemcu = nodemcu || {};
|
||||||
*/
|
*/
|
||||||
function determineSelectedLanguageCode() {
|
function determineSelectedLanguageCode() {
|
||||||
var selectedLanguageCode, path = window.location.pathname;
|
var selectedLanguageCode, path = window.location.pathname;
|
||||||
if (window.location.origin.indexOf('readthedocs') > -1) {
|
if (isOnRtd()) {
|
||||||
// path is like /en/<branch>/<lang>/build/ -> extract 'lang'
|
// path is like /en/<branch>/<lang>/build/ -> extract 'lang'
|
||||||
// split[0] is an '' because the path starts with the separator
|
// split[0] is an '' because the path starts with the separator
|
||||||
selectedLanguageCode = path.split('/')[3];
|
selectedLanguageCode = path.split('/')[3];
|
||||||
|
@ -171,7 +172,7 @@ var nodemcu = nodemcu || {};
|
||||||
*/
|
*/
|
||||||
function determineSelectedBranch() {
|
function determineSelectedBranch() {
|
||||||
var branch = 'dev', path = window.location.pathname;
|
var branch = 'dev', path = window.location.pathname;
|
||||||
if (window.location.origin.indexOf('readthedocs') > -1) {
|
if (isOnRtd()) {
|
||||||
// path is like /en/<branch>/<lang>/build/ -> extract 'lang'
|
// path is like /en/<branch>/<lang>/build/ -> extract 'lang'
|
||||||
// split[0] is an '' because the path starts with the separator
|
// split[0] is an '' because the path starts with the separator
|
||||||
var thirdPathSegment = path.split('/')[2];
|
var thirdPathSegment = path.split('/')[2];
|
||||||
|
@ -192,4 +193,8 @@ var nodemcu = nodemcu || {};
|
||||||
}
|
}
|
||||||
return values;
|
return values;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function isOnRtd() {
|
||||||
|
return window.location.origin.indexOf('readthedocs') > -1;
|
||||||
|
}
|
||||||
}());
|
}());
|
||||||
|
|
|
@ -19,7 +19,7 @@ extra_css:
|
||||||
extra_javascript:
|
extra_javascript:
|
||||||
- js/extra.js
|
- js/extra.js
|
||||||
|
|
||||||
pages:
|
nav:
|
||||||
- Overview: 'index.md'
|
- Overview: 'index.md'
|
||||||
- English:
|
- English:
|
||||||
- Home: 'en/index.md'
|
- Home: 'en/index.md'
|
||||||
|
|
Loading…
Reference in New Issue