facebook/sapling
1
1
Fork 0
mirror of https://github.com/facebook/sapling.git synced 2024-10-07 15:27:13 +03:00
Code Issues Projects Releases Wiki Activity
1ec97ebdc9
sapling/website
History
Evan Krause 1ec97ebdc9 Add note to install sapling to use vscode extension 
Summary:
The  vscode extension does not bundle sapling, thus you must also install sapling with the normal instructions in order to use the extension.

We should add this to the website docs, as well as the README for the VS Code extension (which appears inside the vscode marketplace)

Reviewed By: DurhamG

Differential Revision: D41309780

fbshipit-source-id: 4caad13f5c478252324e6cd3874ef25c0bd735d8
2022-11-15 10:49:31 -08:00
..
docs Add note to install sapling to use vscode extension 2022-11-15 10:49:31 -08:00
fb Re-sync with internal repository 2022-11-15 00:48:09 -08:00
scripts website: add doc for 'sl' 2022-11-15 09:40:01 -08:00
src website: internals/zstdelta 2022-11-15 08:45:09 -08:00
static Re-sync with internal repository 2022-11-15 06:39:33 -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 Re-sync with internal repository 2022-11-15 00:48:09 -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 Re-sync with internal repository 2022-11-15 00:48:09 -08:00
elements.tsx Re-sync with internal repository 2022-11-15 00:48:09 -08:00
package.json Re-sync with internal repository 2022-11-15 00:48:09 -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 Re-sync with internal repository 2022-11-15 00:48:09 -08: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.

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