Documentation Of MaixPy

Read me online	在线阅读

Build Doc

This documentation site is powered by GitBook. You can check out the online version here.

You need Node.js and npm to be able to build the site.

To install gitbook:

npm install gitbook-cli -g

Get Doc source code:

sudo apt install git 
git clone https://github.com/sipeed/MaixPy_DOC.git

Install gitbook plugins:

cd MaixPy_DOC
gitbook install

Serve as a website:

chmode +x serve.sh
./serve.sh

Name	Name	Last commit message	Last commit date
Latest commit Neutree merge Jan 24, 2019 72fb463 · Jan 24, 2019 History 58 Commits
assets	assets	optimize doc	Jan 15, 2019
en	en	add upload script doc (not complete)	Jan 15, 2019
zh	zh	merge	Jan 24, 2019
.bookignore	.bookignore	rename	Jan 11, 2019
.gitignore	.gitignore	optimize tool	Jan 11, 2019
.markdownlint.json	.markdownlint.json	add gitbook framework	Jan 10, 2019
.travis.yml	.travis.yml	test build	Jan 15, 2019
CNAME	CNAME	update web domain	Jan 20, 2019
LANGS.md	LANGS.md	add gitbook framework	Jan 10, 2019
README.md	README.md	optimize theme	Jan 11, 2019
book.json	book.json	optimize theme	Jan 11, 2019
deploy.sh	deploy.sh	add build status	Jan 15, 2019
gulpfile.js	gulpfile.js	add gitbook framework	Jan 10, 2019
index.html	index.html	optimize theme	Jan 11, 2019
index_zh.html	index_zh.html	optimize theme	Jan 11, 2019
package.json	package.json	add gitbook framework	Jan 10, 2019
serve.sh	serve.sh	rename	Jan 11, 2019
serve_daemon.sh	serve_daemon.sh	rename	Jan 11, 2019