Go to file
chaol c9c6b48668 合并远程仓库和本地仓库 2025-06-02 20:39:42 +08:00
.devops 合并远程仓库和本地仓库 2025-06-02 20:39:42 +08:00
.idea 添加文档目录导航和返回顶部按钮功能 2025-06-02 20:23:44 +08:00
docs 合并远程仓库和本地仓库 2025-06-02 20:39:42 +08:00
i18n/zh-CN 添加文档目录导航和返回顶部按钮功能 2025-06-02 20:23:44 +08:00
src 添加文档目录导航和返回顶部按钮功能 2025-06-02 20:23:44 +08:00
static 添加文档目录导航和返回顶部按钮功能 2025-06-02 20:23:44 +08:00
versioned_docs/version-1.1.0 添加文档目录导航和返回顶部按钮功能 2025-06-02 20:23:44 +08:00
versioned_sidebars 添加文档目录导航和返回顶部按钮功能 2025-06-02 20:23:44 +08:00
.gitignore 添加文档目录导航和返回顶部按钮功能 2025-06-02 20:23:44 +08:00
Dockerfile 添加文档目录导航和返回顶部按钮功能 2025-06-02 20:23:44 +08:00
README.md 合并远程仓库和本地仓库 2025-06-02 20:39:42 +08:00
babel.config.js 添加文档目录导航和返回顶部按钮功能 2025-06-02 20:23:44 +08:00
docusaurus.config.js 添加文档目录导航和返回顶部按钮功能 2025-06-02 20:23:44 +08:00
gitee私人令牌.txt 1 2024-06-04 20:58:54 +08:00
package-lock.json 添加文档目录导航和返回顶部按钮功能 2025-06-02 20:23:44 +08:00
package.json 添加文档目录导航和返回顶部按钮功能 2025-06-02 20:23:44 +08:00
prettier.config.js 添加文档目录导航和返回顶部按钮功能 2025-06-02 20:23:44 +08:00
sidebars.js 添加文档目录导航和返回顶部按钮功能 2025-06-02 20:23:44 +08:00
versions.json 添加文档目录导航和返回顶部按钮功能 2025-06-02 20:23:44 +08:00
yarn.lock 合并远程仓库和本地仓库 2025-06-02 20:39:42 +08:00
课程实践任务及要求 (1).pptx 添加文档目录导航和返回顶部按钮功能 2025-06-02 20:23:44 +08:00

README.md

确实开源帮助中心

贡献文档方式

1.复刻主仓库


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


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

  • 克隆复刻仓库到本地后,在gitlink_help_center/docs文件夹下新建文件夹或markdown文档依次执行
 git add <新增文件>
 git commit <新增文件> -m "提交信息"
 git push

<<<<<<< HEAD

  • 在gitlink代码仓库页面进行编辑然后点击"提交变更" =======
  • 在gitlink代码仓库页面进行编辑然后点击“提交变更”

e710542913


3.向主仓提交合并请求


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


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


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

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

e710542913

创建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
    

<<<<<<< HEAD

新增功能特性

1. 文档目录导航功能

在每个文档页面右侧添加了目录导航组件,显示当前文档的所有标题,方便用户快速跳转到需要的部分。目录会根据滚动位置自动高亮当前阅读的章节。

2. 返回顶部按钮

添加了固定的返回顶部按钮,当页面滚动超过一定距离时会显示在右下角,点击可以平滑滚动回页面顶部,提升长文档的阅读体验。

如何使用新功能

这些功能会在页面加载时自动启用,无需额外配置。目录导航在桌面设备上显示,在移动设备上会自动隐藏以节省空间。

=======

e710542913