No Description

Ayush Sharma 022008ab3e chore: update dependencies 5 months ago
.github fc695ed81f chore: added docs 7 months ago
blog fc695ed81f chore: added docs 7 months ago
docs 022008ab3e chore: update dependencies 5 months ago
src fc695ed81f chore: added docs 7 months ago
static 5fe3608e1a feat: completed documentation 7 months ago
.gitignore e9be3f338b fix: gitignore 5 months ago
README.md fc695ed81f chore: added docs 7 months ago
babel.config.js fc695ed81f chore: added docs 7 months ago
docusaurus.config.js 4f949db461 fix: updated analytics ID 7 months ago
package-lock.json fc695ed81f chore: added docs 7 months ago
package.json fc695ed81f chore: added docs 7 months ago
sidebars.js fc695ed81f chore: added docs 7 months ago
versions.json fc695ed81f chore: added docs 7 months ago
yarn.lock fc695ed81f chore: added docs 7 months ago

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.