mirror of
https://github.com/facebook/docusaurus.git
synced 2025-06-04 20:02:54 +02:00
434da1d7ea
* feat(v2): Add bootstrap theme structure * chore(v2): run prettier * chore(v2): remove unused dependencies * feat(v2): add bootstrap preset * feat(v2): add bootstrap template * remove unnecessary stuff * -- Co-authored-by: Yangshun Tay <tay.yang.shun@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.
|