Ayush Sharma
fc695ed81f
chore: added docs
|
1 anno fa | |
|---|---|---|
| .github | 1 anno fa | |
| blog | 1 anno fa | |
| docs | 1 anno fa | |
| src | 1 anno fa | |
| static | 1 anno fa | |
| .gitignore | 1 anno fa | |
| README.md | 1 anno fa | |
| babel.config.js | 1 anno fa | |
| docusaurus.config.js | 1 anno fa | |
| package-lock.json | 1 anno fa | |
| package.json | 1 anno fa | |
| sidebars.js | 1 anno fa | |
| versions.json | 1 anno fa | |
| yarn.lock | 1 anno fa |
README.md
WebSerial Docs
This documentation is built using Docusaurus 2, a modern static website generator.
Installation
$ yarn
Local Development
$ yarn start
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
Build
$ yarn build
This command generates static content into the build directory and can be served using any static contents hosting service.
Deployment
Using SSH:
$ USE_SSH=true yarn deploy
Not using SSH:
$ GIT_USER=<Your GitHub username> yarn deploy
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.