https://github.com/snowtrack/snowtrack-docs
The official documentation of Snowtrack
https://github.com/snowtrack/snowtrack-docs
documentation version-control
Last synced: about 1 year ago
JSON representation
The official documentation of Snowtrack
- Host: GitHub
- URL: https://github.com/snowtrack/snowtrack-docs
- Owner: snowtrack
- License: cc-by-sa-4.0
- Created: 2021-06-07T14:03:06.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2023-03-14T21:53:17.000Z (over 3 years ago)
- Last Synced: 2023-03-14T22:20:16.073Z (over 3 years ago)
- Topics: documentation, version-control
- Language: JavaScript
- Homepage: https://www.snowtrack.io/docs
- Size: 9.53 MB
- Stars: 8
- Watchers: 2
- Forks: 1
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Snowtrack Documentation
**Live:** [www.snowtrack.io/docs](https://www.snowtrack.io/docs)
This is the open-source repository of the documentation of Snowtrack. The documentation is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
## Installation
```console
npm install
```
## Local Development
```console
npm 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. After executing the command above you reach the documentation at http://localhost:3000/docs
## Build
```console
npm build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
## How to contribute?
The documentation is open-source and available under the [CC ShareAlike 4.0](https://creativecommons.org/licenses/by-sa/4.0/) license.
If you would like to contribute to this documentation, feel free to open an issue or pull-request on GitHub. Changes are automatically uploaded to [snowtrack.io/docs](https://www.snowtrack.io/docs) and are live within 10 minutes after approval of the pull-request.