diff options
| author | Fangcat_Dev <fangcat_dev@outlook.com> | 2026-10-17 11:56:52 +0000 |
|---|---|---|
| committer | Fangcat_Dev <fangcat_dev@outlook.com> | 2026-10-17 11:56:52 +0000 |
| commit | fa61b9f49a79bd03c11eaff5857af48dd89edc67 (patch) | |
| tree | ebcd21970220c5a49b0b4a596bf10604e01cad9c /CONTRIBUTING.md | |
| parent | docs(fix): update links (diff) | |
feat: migrate to vitepress
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 43 |
1 files changed, 12 insertions, 31 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d4053a9..c763f7f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,44 +1,25 @@ # 贡献指南 -## 安装必要依赖 +在贡献前,请您首先阅读[贡献准则](./CONTRIBUTING.md)。 -请确保您的电脑已经安装了最新版的Python,并被添加到PATH中。 +## 构建与预览 -在clone仓库后,请您执行来安装必要的库: +您可以参考 https://nodejs.org/zh-cn/download 来安装Node.js与Npm。本站使用Node.js 26进行构建。 -``` -pip install -r requirements.txt -``` - -### venv虚拟环境 - -为防止Python 3安装的依赖污染系统环境导致系统不稳定,建议您创建venv虚拟环境。 +安装之后,请运行以下命令安装依赖(`package-lock.json`已镜像,无需换源): -#### 直接使用Python - -``` -python -m venv .venv -source .venv/bin/activate -pip install -r requirements.txt +```bash +npm install ``` -#### uv -``` -uv venv -source .venv/bin/activate -uv pip install -r requirements.txt -``` - -### 构建 - -> 如果您使用[虚拟环境](#venv虚拟环境),请不要退出此环境 +之后,您可以使用以下命令构建并预览网站。 -我们的文章全部位于/docs目录下。如果您添加了之前不存在的章节,请您修改`mkdocs.yml`下的`nav`(照葫芦画瓢就行)来使得您的内容显示在侧边栏导航。 +```bash +npm run build #构建 -如果您要预览内容,我们建议您执行以下指令来查看网页显示效果: - -``` -mkdocs serve +npm run dev #预览 ``` +## 内容分类 + 如果您的内容难以分类,你可以在 `pending` 目录下新建一个目录,然后存放你的文档,管理员会将它放到正确的地方。 |
