97 lines
2.5 KiB
Markdown
97 lines
2.5 KiB
Markdown
# 文档贡献指南
|
||
|
||
## 1. 文档贡献流程
|
||
|
||
### 1.1. fork 仓库
|
||
|
||
首先，你需要 fork 本仓库到你的 GitHub 账号下。
|
||
项目地址为: [www.github.com/deepin-community](https://github.com/deepin-community/.guide.deepin.org)
|
||
|
||
看到右上角的fork按钮了吗？点击它，就可以将本仓库复制到你的账号下了。
|
||
|
||
### 1.2. 克隆仓库
|
||
|
||
你需要将你的仓库克隆到本地，然后在本地进行修改。
|
||
|
||
```bash
|
||
git clone https://github.com/deepin-community/.guide.deepin.org.git
|
||
```
|
||
|
||
然后使用文本编辑器打开仓库，你会看到如下目录结构：
|
||
|
||
```
|
||
.
|
||
├── docs
|
||
├── LICENSE
|
||
├── node_modules
|
||
├── package.json
|
||
├── pnpm-lock.yaml
|
||
├── README.md
|
||
└── yarn.lock
|
||
```
|
||
|
||
你需要写的文档就在docs目录下，你可以在这个目录下新建一个文件夹，然后在这个文件夹下写你的文档。
|
||
和现在这篇文档一样。
|
||
|
||
如果你需要修改侧边栏，你需要修改`docs/.vitepress/config.js`文件。
|
||
|
||
### 1.3. 本地渲染
|
||
|
||
#### 安装依赖
|
||
|
||
本文档使用vitepress作为文档渲染工具，你需要安装vitepress的依赖。
|
||
|
||
你需要安装nodejs和pnpm，然后使用pnpm来安装依赖。
|
||
|
||
```bash
|
||
pnpm install
|
||
```
|
||
|
||
使用`pnpm dev`来本地渲染文档。
|
||
|
||
```bash
|
||
pnpm dev
|
||
```
|
||
|
||
**注意：如果你使用的是yarn，你需要将`pnpm`替换为`yarn`**
|
||
|
||
#### 本地渲染效果
|
||
|
||
你可以在浏览器中打开`http://localhost:3000`来查看本地渲染效果。
|
||
注意这个端口并不固定，会在你运行后在终端中显示。
|
||
|
||
### 1.4. 提交修改
|
||
|
||
提交修改到你的仓库。
|
||
|
||
```bash
|
||
git add .
|
||
git commit -m "docs: add new doc"
|
||
git push
|
||
```
|
||
|
||
注意 commit 信息需要符合[约定式提交规范](https://www.conventionalcommits.org/zh-hans/v1.0.0-beta.4/)。
|
||
|
||
### 1.5. 发起 Pull Request
|
||
|
||
在你的仓库中，点击`Pull requests`，然后点击`New pull request`，然后点击`Create pull request`。
|
||
|
||
## 2. 文档格式
|
||
|
||
### 2.1. Markdown
|
||
|
||
本文档使用Markdown作为文档格式，你可以在[这里](https://www.markdownguide.org/basic-syntax/)查看Markdown的基本语法。
|
||
|
||
### 2.2. Vitepress
|
||
|
||
本文档使用Vitepress作为文档渲染工具，你可以在[这里](https://vitepress.vuejs.org/)查看Vitepress的文档。
|
||
|
||
## 3. CLA协议
|
||
|
||
本仓库使用CLA协议，你无需签署CLA协议，如果你提交pr,则视为你已经同意CLA协议。
|
||
[CLA协议](https://github.com/linuxdeepin/cla)
|
||
|
||
## 4. License
|
||
|
||
本仓库使用LGPL-3.0-or-later License ，你可以在此License下自由使用本仓库的内容。
|