Contributing to SwanLab Official Documentation
Contributing to the project is not limited to code contributions; maintaining documentation, answering questions in issues and groups, submitting bugs, and more are all ways to contribute to the swanlab project!
We host the official documentation for SwanLab in our GitHub repository, based on vitepress.
How to Contribute to the Documentation
It's simple! Just clone the project, add or modify Markdown files, submit them, and create a PR.
Environment Setup
- Clone this repository
git clone https://github.com/SwanHubX/SwanLab-Docs- Install the dependency environment
You need to install nodejs and npm in advance. For detailed methods, please refer to the node official tutorial.
Use the following command to install other dependent projects:
npm add -D vitepressRunning Documentation Locally
If you are developing locally or previewing the documentation, you can run the following command in the project root directory:
npm run docs:devIf you want to perform a complete compilation and packaging, use the following commands:
npm run docs:build
npm run docs:preview