This repository contains the sources and tools needed to push out the website and training materials for SimpleIOT.
The live site can be seen here.
This repo includes sources to:
- Web-site, built using Docusaurus
- Documentation sources
- Training materials (including workshops, etc.)
The output will be auto-deployed to Github pages and can be accessed via https://simpleiot.net/.
These are the current documentation channels:
| Name | Framework | Purpose | Directory |
|---|---|---|---|
| Home | Docusaurus | Landing page | website |
| CLI Docs | (Embedded in Docusaurus) | Command-line documentation | website/simpleiot/docs/documentation/cli |
| API Docs | (Embedded in Docusaurus) | REST API documentation (coming soon) | docsrc/simpleiot/docs/documentation/api |
| Arduino Client SDK | (Embedded in Docusaurus) | C++ SDK for the Arduino platform | docsrc/simpleiot/docs/documentation/sdk |
| Starter Workshop | (Embedded in Docusaurus) | HelloWorld and SensorDemo workshop | website/simpleiot/docs/workshops/starter |
The documentation sources are in Markdown format, under the website/simpleiot/docs directory. Docusaurus renders them into static HTML during the build process. The material pushed out is generated HTML/CSS/JS under the gh-pages branch.
The media directory contains material not directly related to the website. This includes source material such as 3D models, presentation files, illustration sources, and SVG files for the Starter Kit.
Thw website/simpleiot/rawmedia directory contains source material for images used throughout the website, documentation, and workshops. The outputs are scaled and sized and stored in the website/static/img directory.
cd website/simpleiot
npm install
npm run serve
The website will be built locally and can be browsed at http://localhost:3000/.
Once changes are made, they can be pushed out to the main branch.
The Github action workflow file is under: simpleiot-build/.github/workflows/deploy-website.yml. Any push to the main branch will automatically invoke the build process to automatically update the website on the gh-pages branch.
To manually build and push the website, build the site locally and verify there are no errors:
npm run build
Then to deploy to the website:
export GIT_USER="{your-git-user-name}"
export GIT_PASS="{your-git-password-or-token}"
export CURRENT_BRANCH="main"
npm run deploy
See CONTRIBUTING for more information.
This project is licensed under the Apache-2.0 License.