Go to file
xxq250 f2572f3e82 Merge pull request '修复WebIDE表项格式未对齐的问题' (#41) from SheYuWu03/gitlink_help_center:master into master 2024-05-26 21:13:36 +08:00
.devops feat: .devops/【测试环境】合并请求通过后自动更新.yml 2024-05-11 07:33:33 +00:00
docs Merge pull request '修复WebIDE表项格式未对齐的问题' (#41) from SheYuWu03/gitlink_help_center:master into master 2024-05-26 21:13:36 +08:00
i18n/zh-CN i18n 2023-03-30 15:41:50 +08:00
src 底部信息调整 2023-09-15 17:37:51 +08:00
static 更新wiki部分的md文件 2024-05-24 00:13:54 +08:00
.gitignore init 2023-03-15 10:38:43 +08:00
README.md Update README.md 2024-05-24 20:07:31 +08:00
babel.config.js init 2023-03-15 10:38:43 +08:00
docusaurus.config.js url 2023-09-15 18:09:26 +08:00
package-lock.json 搜索不了中文 2023-07-07 10:41:35 +08:00
package.json npm 2023-07-17 10:02:08 +08:00
prettier.config.js save 2023-07-05 14:43:25 +08:00
sidebars.js search 2023-07-05 16:43:45 +08:00
yarn.lock npm 2023-07-17 10:02:08 +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
    

    开发模式

    启动

    npm run dev