Type Horror 25bb6738ea feat: Add fitToContent and animate to scrollToContent (#6319) 1 year ago
..
docs 25bb6738ea feat: Add fitToContent and animate to scrollToContent (#6319) 1 year ago
src f23cdc47ee docs: migrating dev docs to docusaurus :) (#6073) 1 year ago
static f23cdc47ee docs: migrating dev docs to docusaurus :) (#6073) 1 year ago
.gitignore 966ca2ffa6 refactor: rename docs to dev-docs (#5487) 2 years ago
README.md 966ca2ffa6 refactor: rename docs to dev-docs (#5487) 2 years ago
babel.config.js 966ca2ffa6 refactor: rename docs to dev-docs (#5487) 2 years ago
docusaurus.config.js 71fb60394a docs: enable Algolia for search (#6230) 1 year ago
package.json f23cdc47ee docs: migrating dev docs to docusaurus :) (#6073) 1 year ago
sidebars.js f23cdc47ee docs: migrating dev docs to docusaurus :) (#6073) 1 year ago
tsconfig.json 966ca2ffa6 refactor: rename docs to dev-docs (#5487) 2 years ago
yarn.lock e718136aea build(deps): bump webpack from 5.74.0 to 5.76.1 in /dev-docs (#6356) 1 year 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.