https://github.com/rmuif/docs
:book: Documentation for RMUIF built using Docusaurus 2.
https://github.com/rmuif/docs
docs docusaurus2 rmuif
Last synced: about 1 year ago
JSON representation
:book: Documentation for RMUIF built using Docusaurus 2.
- Host: GitHub
- URL: https://github.com/rmuif/docs
- Owner: rmuif
- License: mit
- Created: 2020-03-07T15:53:57.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-05T16:26:37.000Z (over 3 years ago)
- Last Synced: 2025-04-12T01:55:45.349Z (about 1 year ago)
- Topics: docs, docusaurus2, rmuif
- Language: JavaScript
- Homepage: https://docs.rmuif.com
- Size: 2.36 MB
- Stars: 5
- Watchers: 1
- Forks: 2
- Open Issues: 37
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Docs
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= 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.