botbook/README.md

42 lines
775 B
Markdown
Raw Normal View History

# Website
2020-09-28 16:45:14 -03:00
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
### Installation
```
$ pnpm i
````
### Local Development
```
$ pnpm 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
```
$ pnpm 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 pnpm i deploy
```
Not using SSH:
```
$ GIT_USER=<Your GitHub username> pnpm i 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.