https://github.com/papercups-io/docs
Documentation for Papercups
https://github.com/papercups-io/docs
Last synced: 5 months ago
JSON representation
Documentation for Papercups
- Host: GitHub
- URL: https://github.com/papercups-io/docs
- Owner: papercups-io
- Created: 2021-02-18T20:41:48.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-03-06T10:52:06.000Z (over 2 years ago)
- Last Synced: 2024-04-14T17:01:04.004Z (about 1 year ago)
- Language: JavaScript
- Homepage: https://docs.papercups.io
- Size: 463 KB
- Stars: 0
- Watchers: 3
- Forks: 7
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing.md
Awesome Lists containing this project
README
# Website
This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
## Installation
```console
npm install
```
## Local Development
```console
npm 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
```console
npm build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
## Deployment
```console
GIT_USER= USE_SSH=true npm 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.