tabby/website
Meng Zhang 5546794b65 rename docs to website 2023-06-05 18:39:33 -07:00
..
blog rename docs to website 2023-06-05 18:39:33 -07:00
docs rename docs to website 2023-06-05 18:39:33 -07:00
src rename docs to website 2023-06-05 18:39:33 -07:00
static rename docs to website 2023-06-05 18:39:33 -07:00
.gitignore rename docs to website 2023-06-05 18:39:33 -07:00
README.md rename docs to website 2023-06-05 18:39:33 -07:00
babel.config.js rename docs to website 2023-06-05 18:39:33 -07:00
configuration.md rename docs to website 2023-06-05 18:39:33 -07:00
docusaurus.config.js rename docs to website 2023-06-05 18:39:33 -07:00
package.json rename docs to website 2023-06-05 18:39:33 -07:00
sidebars.js rename docs to website 2023-06-05 18:39:33 -07:00
yarn.lock rename docs to website 2023-06-05 18:39:33 -07:00

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.