You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
success/dev-docs
Aakansha Doshi eb9eeefc63
fix: edit link in docs (#6182)
2 years ago
..
docs docs: migrating dev docs to docusaurus :) (#6073) 2 years ago
src docs: migrating dev docs to docusaurus :) (#6073) 2 years ago
static docs: migrating dev docs to docusaurus :) (#6073) 2 years ago
.gitignore refactor: rename docs to dev-docs (#5487) 3 years ago
README.md refactor: rename docs to dev-docs (#5487) 3 years ago
babel.config.js refactor: rename docs to dev-docs (#5487) 3 years ago
docusaurus.config.js fix: edit link in docs (#6182) 2 years ago
package.json docs: migrating dev docs to docusaurus :) (#6073) 2 years ago
sidebars.js docs: migrating dev docs to docusaurus :) (#6073) 2 years ago
tsconfig.json refactor: rename docs to dev-docs (#5487) 3 years ago
yarn.lock docs: migrating dev docs to docusaurus :) (#6073) 2 years ago

README.md

Website

This website 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.