https://github.com/lanfly/nodemcu-zh

https://github.com/lanfly/nodemcu-zh

Last synced: 3 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/lanfly/nodemcu-zh
• Owner: LanFly
• License: apache-2.0
• Created: 2019-04-17T16:48:17.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-04-28T18:07:18.000Z (over 5 years ago)
• Last Synced: 2024-11-12T10:44:34.020Z (2 months ago)
• Language: CSS
• Size: 4.73 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 这是什么？

这是由 `提莫的神秘商店` 发起的开源项目，目标是对英文的 [nodemcu](https://nodemcu.readthedocs.io/en/master/) 网站进行翻译，使得国人更容易理解和查阅文档。

同时为了让更多 nodemcu 新用户更好的运用板子资源，也会编写各个功能模块的实际应用。

此项目已经发布在 [nodemcu.timor.tech](http://nodemcu.timor.tech) 上，由提莫的神秘商店长期维护。为了方便读者阅读，及时获取到最新的、最全的资料，不建议 CSDN 以及类似的博客将此项目完全搬到自己频道内。

这样做不好的原因是：

 - 用户搜出来的内容，打开连接发现全是一模一样的内容。

 - 如果内容中有错误，源站更新了，只能靠各博主人肉更新同步，用户看到的内容无法保证是最新的。

如果你真的有这样的需求，可以联系我，合理的需求我们很乐意协助你一起完成。

# 版权声明

此项目使用 Apache 2.0 LICENSE 开源许可，任何人都可以转载此项目页面中的内容，但必须在开头注明原出处：`提莫的神秘商店（http://timor.tech）`

此项目内容主要来源于对英文网站（https://nodemcu.readthedocs.io/en/master/）的翻译，以及在此基础上进行的创作。

如果有任何内容侵犯你的权利，你可以通过此网站上的信息联系我删除。

# 安装

```shell

npm install gitbook-cli -g

gitbook install

```

# 启动

```shell

gitbook serve

```

# 查看

使用浏览器打开URL：`127.0.0.1:4000`

# 和我们一起完善此文档

如果你也是一名喜爱开源硬件或者 nodemcu 的用户，如果你擅长英文，如果你只是想为开源社区贡献点什么，你都可以在 [GitHub][github] 上 [fork][github] 我们的项目，然后提交你的 pull request，我们会立马处理。

如果你没使用过 GitHub，你可以将文档通过邮件的形式发送给我们，并在开头署名，我们收到邮件会帮你更新在网站上。

一旦你的贡献被合并，将会在网站的显著位置展示，优秀的贡献者将会收到我们的小小心意：由 `提莫的神秘商店` 赠送的 [nodemcu-esp8266 WIFI 开发板][esp8266] 一块，别担心，这不是骗局，无需花费一分钱，我们`包邮`送到你家门口。

贡献的内容富有创意，或者贡献特别优秀的，同样我们会表示小小的心意：由 `提莫的神秘商店` 赠送的 [nodemcu-esp32 WIFI-蓝牙 2合1 开发板][esp32] 一块。

以上活动不限名额，只要此声明还在，活动就有效。评审由 `提莫的神秘商店` 决定，每个名额将会列出通过原因。

小小心意，略表敬意。我们绝不是打广告，只是为开源做点什么，这也是我们的主旨。最终解释权归 `提莫的神秘商店` 所有。

[github]: https://github.com/LanFly/nodemcu-zh