https://github.com/stream-pi/documentation
Stream-Pi Documentation [CURRENTLY UNDER CONSTRUCTION]
https://github.com/stream-pi/documentation
documentation docusaurus react typescript
Last synced: 8 months ago
JSON representation
Stream-Pi Documentation [CURRENTLY UNDER CONSTRUCTION]
- Host: GitHub
- URL: https://github.com/stream-pi/documentation
- Owner: stream-pi
- Created: 2020-10-10T16:04:35.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2021-07-07T22:20:26.000Z (over 4 years ago)
- Last Synced: 2025-04-05T09:11:14.996Z (9 months ago)
- Topics: documentation, docusaurus, react, typescript
- Language: JavaScript
- Homepage: https://documentation.stream-pi.com/
- Size: 942 KB
- Stars: 12
- Watchers: 7
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Website
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
## Installation
```console
yarn install
```
## Local Development
```console
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
```console
yarn 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 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.