PhyrePanel-mirror/docs/contributing/documentation.md
2024-05-17 22:28:55 +03:00

575 B

Contributing to Phyre Panel documentation

The documentation is built using VitePress. 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.

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.