sapling/website
Jun Wu 4ac3c81845 website: submoudle -> submodule
Summary: Fix a typo.

Reviewed By: zzl0

Differential Revision: D43966393

fbshipit-source-id: a34e9e8c11e49adac5cad11e96bee7882400d6f3
2023-03-13 18:21:43 -07:00
..
docs website: submoudle -> submodule 2023-03-13 18:21:43 -07:00
fb Re-sync with internal repository 2022-11-15 00:48:09 -08:00
scripts website: fix website generation 2023-03-03 08:05:33 -08:00
src website: fix website generation 2023-03-03 08:05:33 -08:00
static update ISL screenshots for website to show sl instead of hg 2022-12-07 17:39:48 -08:00
.eslintrc.js Re-sync with internal repository 2022-11-15 00:48:09 -08:00
.gitignore Re-sync with internal repository 2022-11-15 00:48:09 -08:00
.prettierignore Re-sync with internal repository 2022-11-15 00:48:09 -08:00
.prettierrc increase column length so Prettier formats tables 2022-11-18 18:27:04 -08:00
.stylelintrc.js Re-sync with internal repository 2022-11-15 00:48:09 -08:00
babel.config.js Re-sync with internal repository 2022-11-15 00:48:09 -08:00
constants.js Re-sync with internal repository 2022-11-15 00:48:09 -08:00
docusaurus.config.js website: linkify GitHub links 2023-03-06 10:39:41 -08:00
elements.tsx Re-sync with internal repository 2022-11-15 00:48:09 -08:00
package.json website: linkify GitHub links 2023-03-06 10:39:41 -08:00
README.md Re-sync with internal repository 2022-11-15 00:48:09 -08:00
sidebars.js Re-sync with internal repository 2022-11-15 00:48:09 -08:00
tsconfig.json Re-sync with internal repository 2022-11-15 00:48:09 -08:00
yarn.lock website: linkify GitHub links 2023-03-06 10:39:41 -08:00

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.

Continuous Integration

Some common defaults for linting/formatting have been set for you. If you integrate your project with an open source Continuous Integration system (e.g. Travis CI, CircleCI), you may check for issues using the following command.

$ yarn ci