https://github.com/syscoin/sys-docs
https://github.com/syscoin/sys-docs
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/syscoin/sys-docs
- Owner: syscoin
- Created: 2021-11-21T10:27:44.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-03-22T16:39:41.000Z (about 2 years ago)
- Last Synced: 2024-05-29T17:25:58.322Z (about 2 years ago)
- Language: JavaScript
- Size: 19.9 MB
- Stars: 2
- Watchers: 9
- Forks: 3
- Open Issues: 2
-
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.
NOTE: If any of the tables in the root directory have been changed then run the command below in order to update the tables on the website.
```console
node tableConverter.js
```
## 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.