sapling/website
Jun Wu 7b8032985e website: use consistent file name for curl and install
Summary:
strager pointed out the URL has `%2B` in it (so curl writes the file with the
`%2B` name) and the file name below uses `+`. Use `-o` with the desired file
names to avoid issues.

Reviewed By: muirdm

Differential Revision: D45620202

fbshipit-source-id: 27c9247fada2b702888d9f888c8e80c9e3e29a8d
2023-05-08 11:10:58 -07:00
..
docs website: use consistent file name for curl and install 2023-05-08 11:10:58 -07:00
fb Re-sync with internal repository 2022-11-15 00:48:09 -08:00
scripts fix subcommands in pr.md (#596) 2023-04-14 14:32:17 -07: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 build(deps): bump @braintree/sanitize-url from 6.0.0 to 6.0.2 in /website (#586) 2023-04-25 14:37:20 -07: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