mirror of
https://github.com/PhyreApps/PhyrePanel.git
synced 2024-09-19 23:31:12 +00:00
16 lines
575 B
Markdown
16 lines
575 B
Markdown
|
# Contributing to Phyre Panel documentation
|
||
|
|
|
||
|
|
The documentation is built using [VitePress](https://vitepress.vuejs.org). There are a couple of requirements to contribute to it.
|
||
|
|
|
||
|
|
## Requirements
|
||
|
|
|
||
|
|
- Node.js 16 or higher
|
||
|
|
- A code editor with Vue and Markdown support. We suggest [Visual Studio Code](https://code.visualstudio.com).
|
||
|
|
|
||
|
|
## Viewing your changes locally
|
||
|
|
|
||
|
|
1. Open the project folder in your terminal.
|
||
|
|
2. If the dependencies are not installed yet, install them by running `npm install`.
|
||
|
|
3. Run `npm run docs:dev`.
|
||
|
|
4. Navigate to `http://localhost:5173` in your browser.
|