Go to file
caishi 4bcb1109a2 color 2023-06-28 10:37:11 +08:00
.devops feat: .devops/合并请求通过后自动更新.yml 2023-05-09 11:48:51 +08:00
blog init 2023-03-15 10:38:43 +08:00
docs Merge pull request '帮助中心文案-快速开始部分' (#26) from Cml6677/gitlink_help_center:master into master 2023-06-11 14:59:58 +08:00
i18n/zh-CN i18n 2023-03-30 15:41:50 +08:00
src color 2023-06-28 10:37:11 +08:00
static Merge pull request '帮助中心文案-快速开始部分' (#26) from Cml6677/gitlink_help_center:master into master 2023-06-11 14:59:58 +08:00
.gitignore init 2023-03-15 10:38:43 +08:00
README.md Update README.md 2023-05-08 15:09:13 +08:00
babel.config.js init 2023-03-15 10:38:43 +08:00
docusaurus.config.js color 2023-06-28 10:37:11 +08:00
package-lock.json color 2023-06-28 10:37:11 +08:00
package.json init 2023-03-15 10:38:43 +08:00
sidebars.js init 2023-03-15 10:38:43 +08:00
yarn.lock style 2023-03-15 13:56:22 +08:00

README.md

确实开源帮助中心

贡献文档方式

1.复刻主仓库


2.进入复刻仓库编辑文档


可采用如下两种方式编辑:

  • 克隆复刻仓库到本地后,在gitlink_help_center/docs文件夹下新建文件夹或markdown文档依次执行
 git add <新增文件>
 git commit <新增文件> -m "提交信息"
 git push
  • 在gitlink代码仓库页面进行编辑然后点击“提交变更”

3.向主仓提交合并请求


页面目录——仓库目录示意图


1.如下图左边为帮助中心侧边栏一级目录展示效果,右边为代码仓库文件夹目录:


2.如下图左边为帮助中心侧边栏点击一级目录“Test1”后展开效果右边为点击代码仓库文件夹“test1”后md文件目录

创建markdown文档

  • 创建第一篇文档 在docs/test1目录下创建hello.md

    # Hello
    
    This is my **first  document**!
    

    在一级标题中:#与标题内容间需要入空格(# Hello)

  • 配置侧边栏

    ---
    sidebar_label: 'Hi!'      <!--定义侧边栏标签名称-->
    sidebar_position: 3     <!--定义侧边栏层级位置-->
    ---
    
    # Hello
    
    This is my **first document**!
    

  • 链接

    支持使用 url 路径或相对文件路径的常规 Markdown 链接

    git操作 [git](/git).
    
    git操作 [git](./git.md).
    

  • 图片

    支持常规markdown图片static/img/gitlink_logo.png中添加一个图像.png并在Markdown中显示它

    ![gitlink logo](/img/gitlink_logo.png)
    
    

    前端build成中文 i18n中可编辑对应中文内容

    npm run build -- --locale zh-CN 启动 npm run serve