https://github.com/illumina/illuminaconnectedannotationsdocumentation
https://github.com/illumina/illuminaconnectedannotationsdocumentation
Last synced: 9 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/illumina/illuminaconnectedannotationsdocumentation
- Owner: Illumina
- Created: 2023-11-02T19:22:26.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2025-02-21T20:38:03.000Z (10 months ago)
- Last Synced: 2025-02-21T21:39:07.495Z (10 months ago)
- Language: MDX
- Size: 57.6 MB
- Stars: 1
- Watchers: 11
- Forks: 1
- Open Issues: 0
-
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
```shell
yarn install
```
## Local Development
```shell
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
```shell
yarn build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
## Deployment
```shell
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.
## Bump Version
```shell
npm run docusaurus docs:version 3.22
```
## Generate PDF
```shell
npm install -g docs-to-pdf@v0.6.2
npx docs-to-pdf docusaurus --initialDocURLs="https://illumina.github.io/IlluminaConnectedAnnotationsDocumentation/" --contentSelector="article" --paginationSelector="div.pagination-nav__item.pagination-nav__item--next > a.pagination-nav__link"
```