Repository files navigation

This repository regroups documentation and information that is hosted on the SwanLab website.

You can access the SwanLab documentation atDocument. Powered byvitepress.

It's very simple! Just clone the project, add or modify Markdown files, commit them, and then create a PR.

1. Clone this repository

git clone https://github.com/SwanHubX/SwanLab-Docscd SwanLab-Docs

2. Install

You need to install nodejs and npm in advance. For detailed instructions, please refer to theNode.js tutorial.

Use the following commands to install other dependencies:

npm add -D vitepressnpm install

3. Run

If you are performing local development or previewing documents, you can run the following in the project root directory:

npm run docs:dev

If a complete compilation and packaging is required, use the following command:

npm run docs:buildnpm run docs:preview