https://github.com/illumina/nirvanadocumentation
https://github.com/illumina/nirvanadocumentation
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/illumina/nirvanadocumentation
- Owner: Illumina
- Created: 2020-06-10T20:33:34.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-03-04T17:12:30.000Z (over 1 year ago)
- Last Synced: 2025-03-24T07:07:27.698Z (3 months ago)
- Language: MDX
- Size: 67 MB
- Stars: 5
- Watchers: 8
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.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
yarn install
```
## Local Development
```console
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
```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.