https://github.com/convoypanel/documentation
Convoy Panel documentation
https://github.com/convoypanel/documentation
Last synced: 9 months ago
JSON representation
Convoy Panel documentation
- Host: GitHub
- URL: https://github.com/convoypanel/documentation
- Owner: ConvoyPanel
- Created: 2022-08-01T18:31:15.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2025-05-07T23:29:52.000Z (about 1 year ago)
- Last Synced: 2025-05-08T00:27:50.560Z (about 1 year ago)
- Language: Vue
- Homepage: https://convoypanel.com
- Size: 7.01 MB
- Stars: 2
- Watchers: 2
- Forks: 9
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: .github/contributing/guidelines.md
Awesome Lists containing this project
README
# Convoy documentation
## Contributing
This site is built with [VitePress](https://github.com/vuejs/vitepress) and depends
on [@vue/theme](https://github.com/vuejs/vue-theme). Site content is written in Markdown format located in `src`. For
simple edits, you can directly edit the file on GitHub and generate a Pull Request.
For local development, [npm](https://npmjs.com/) is preferred as package manager:
```bash
npm i
npm run dev
```
This project requires Node.js to be `v14.0.0` or higher, because we use new JavaScript features in our code, such as
optional chaining.
## Working on the content
- See VitePress docs on supported [Markdown Extensions](https://vitepress.dev/guide/markdown) and the ability
to [use Vue syntax inside markdown](https://vitepress.dev/guide/using-vue).
- See the [Writing Guide](https://github.com/convoypanel/documentation/blob/master/.github/contributing/guidelines.md)
for our rules and recommendations on writing and maintaining documentation content.