mirror of
https://github.com/facebook/docusaurus.git
synced 2025-05-02 11:47:23 +02:00
bb33f54ba8
* feat:added support for codesandbox * added sandbox config file * feat:added script to generate template for codesandbox * added examples:generate script to package.json file * added failing path to eslintignore * added script to eslintignore * added cleaning feature to script * deleted sandbox script in root * changed comment in codesandboxscript file * update codesandboxscript.js + revert bad package.json changes * eslint should check codesandboxscript Co-authored-by: slorber <lorber.sebastien@gmail.com>
33 lines
721 B
Markdown
33 lines
721 B
Markdown
# Website
|
|
|
|
This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
|
|
|
|
### Installation
|
|
|
|
```
|
|
$ yarn
|
|
```
|
|
|
|
### Local Development
|
|
|
|
```
|
|
$ yarn start
|
|
```
|
|
|
|
This command starts a local development server and open 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
|
|
|
|
```
|
|
$ GIT_USER=<Your GitHub username> USE_SSH=true 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.
|