https://github.com/beaver-notes/beaver-docs
Beaver's Official Documentation
https://github.com/beaver-notes/beaver-docs
beaver-notes documentation
Last synced: 2 months ago
JSON representation
Beaver's Official Documentation
- Host: GitHub
- URL: https://github.com/beaver-notes/beaver-docs
- Owner: Beaver-Notes
- Created: 2024-06-02T21:05:01.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-05T22:27:00.000Z (12 months ago)
- Last Synced: 2025-03-05T23:25:53.365Z (12 months ago)
- Topics: beaver-notes, documentation
- Language: HTML
- Homepage: https://beaver-notes.github.io/Beaver-Docs/
- Size: 77.5 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
Awesome Lists containing this project
README
# Website
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
### Installation
```
$ yarn
```
### Local Development
```
$ 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
```
$ yarn 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 yarn deploy
```
Not using SSH:
```
$ GIT_USER= 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.