Tessel 2 Docs
This is a GitBook-formatted guide. You may read the processed document at https://www.gitbook.com/book/tessel/t2-docs/details. PRs to this repository are automatically published online.
Developing the Gitbook
Editing online
GitBooks are editable online! Visit the GitBook repository for the Tessel 2 docs to suggest changes through a graphical editing format.
Requirements
The docs are built using a command line tool called GitBook, which requires:
Running GitBook locally
- Clone this repo:
https://github.com/tessel/t2-docs.git
(Learn more here) - Moving into the docs directory:
cd t2-docs
- Install the project dependecies:
npm install
- Start the documentation generation:
npm start
Changing the contents
SUMMARY.md is autogenerated using the gitbook-summary tool, using instructions from book.json
. The command to regenerate is npm run build
, which is automatically run during the npm start
command.
Deployment
The master
branch of this repo is automatically deployed when new changes are committed. Updates are deployed via GitBook (see build history by commit) to display at tessel.io/docs.