跳到主要内容
版本:Next

如何为帮助中心贡献

GitLink 帮助中心是一个开源文档项目,欢迎所有人参与贡献!

贡献流程

1. 复刻项目

点击项目右上角的 "复刻"(Fork) 按钮,将项目复制到您的个人账户下。

2. 编辑文档

有两种编辑方式:

方式一:网页端直接编辑

  1. 进入您复刻的仓库
  2. 找到需要修改的文件(docs/ 目录下的 .md 文件)
  3. 点击文件上方的 编辑 按钮(铅笔图标)
  4. 修改内容并提交

方式二:本地编辑

git clone https://gitlink.org.cn/您的用户名/gitlink_help_center.git
cd gitlink_help_center
npm install --legacy-peer-deps
npm run dev
# 在浏览器中访问 http://localhost:3000 预览

3. 文档格式规范

每个 Markdown 文件应包含以下 frontmatter:

---
sidebar_label: 页面显示标题
sidebar_position: 排序位置
---

4. 提交合并请求

修改完成后,向原仓库提交合并请求:

  1. 在原仓库页面点击 合并请求 → 新建合并请求
  2. 选择您的修改分支作为源分支
  3. 填写修改说明
  4. 等待审核

贡献类型

类型说明示例
错别字修正修正文档中的错别字"帐号" → "账号"
内容补充补充缺失或不完整的文档补充操作步骤
截图更新更新过时的界面截图替换旧版界面图
新增章节添加全新的文档章节FAQ 页面
功能建议提出网站功能改进建议新增搜索功能

注意事项

  • 提交前请运行 npm run build -- --locale zh-CN 确保构建通过
  • 提交信息请使用规范格式:fix:docs:feat:
  • 如有疑问,可在项目中提交疑修(Issue)讨论

感谢您的贡献!每一份改进都让 GitLink 帮助中心变得更好。

这篇文档对您有帮助吗?