https://github.com/violinist-dev/docs
Documentation for Violinist
https://github.com/violinist-dev/docs
Last synced: 11 months ago
JSON representation
Documentation for Violinist
- Host: GitHub
- URL: https://github.com/violinist-dev/docs
- Owner: violinist-dev
- License: mit
- Created: 2018-03-15T18:33:18.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2025-04-07T04:39:21.000Z (about 1 year ago)
- Last Synced: 2025-04-07T05:27:44.316Z (about 1 year ago)
- Language: TypeScript
- Homepage: https://docs.violinist.io/
- Size: 1.83 MB
- Stars: 0
- Watchers: 1
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# docs.violinist.io
Documentation for Violinist
## Requirements
- NodeJS (Currently v22)
- npm
## Adding a new doc page
If the page is a configuration option, it should go inside `docs/configuration/`. If it's a general documentation page, place a new `mdx` (or `md`) file in the preferred location.
## Development mode
```
$ npm start
```
The docs will probably be available on [http://localhost:3000/](http://localhost:3000/)
## Build the docs
The docs are built automatically when you open a PR, and again on the default branch. So you do not need to incude any generated assets in your PR