https://github.com/synmetrix/docs
https://github.com/synmetrix/docs
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/synmetrix/docs
- Owner: synmetrix
- License: mit
- Created: 2023-09-22T17:29:01.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-29T16:05:52.000Z (11 months ago)
- Last Synced: 2025-03-01T20:48:00.963Z (3 months ago)
- Language: MDX
- Homepage: https://docs.synmetrix.org/
- Size: 65.9 MB
- Stars: 0
- Watchers: 4
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Website
This website is built using [Docusaurus 2](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.