Aucune description

Ayush Sharma c938081507 fix: remove ascii tip il y a 11 mois
.github fc695ed81f chore: added docs il y a 11 mois
blog fc695ed81f chore: added docs il y a 11 mois
docs c938081507 fix: remove ascii tip il y a 11 mois
src fc695ed81f chore: added docs il y a 11 mois
static 5fe3608e1a feat: completed documentation il y a 11 mois
.gitignore fc695ed81f chore: added docs il y a 11 mois
README.md fc695ed81f chore: added docs il y a 11 mois
babel.config.js fc695ed81f chore: added docs il y a 11 mois
docusaurus.config.js 4f949db461 fix: updated analytics ID il y a 11 mois
package-lock.json fc695ed81f chore: added docs il y a 11 mois
package.json fc695ed81f chore: added docs il y a 11 mois
sidebars.js fc695ed81f chore: added docs il y a 11 mois
versions.json fc695ed81f chore: added docs il y a 11 mois
yarn.lock fc695ed81f chore: added docs il y a 11 mois

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.