sapling/website
Jun Wu e27c1ce127 renderdag: make serde an optional dependency
Summary: It is only used by the website SVG renderer. Let's make it optional.

Reviewed By: muirdm

Differential Revision: D42590209

fbshipit-source-id: 17231e8468792dfb87cc2010d4b74257fb5257b6
2023-01-23 11:38:41 -08:00
..
docs fix windows install codeblocks (#454) 2023-01-19 10:11:59 -08:00
fb Re-sync with internal repository 2022-11-15 00:48:09 -08:00
scripts temporary fix to website command codegen to work around escaping issue (#352) 2022-12-23 15:07:36 -08:00
src renderdag: make serde an optional dependency 2023-01-23 11:38:41 -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 add link to discord community 2022-11-16 13:43:49 -08:00
elements.tsx Re-sync with internal repository 2022-11-15 00:48:09 -08:00
package.json automatic update for docusaurus-plugin-internaldocs-fb@1.4.0 2023-01-18 02:48:34 -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 build(deps): bump json5 from 1.0.1 to 1.0.2 in /website (#381) 2023-01-19 10:21:42 -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