MKB

Manlink Knowledge Base

About

此仓库用于储存及生成知识库网页

点我访问正式版网页

若无法访问，尝试直接访问ip

---

Getting Started

前期准备

1. 在这里注册账号
2. 通知管理员将账户加入Manlink_Doc 仓库
3. 确保连接manlink_internal网络
4. 确保可以访问公共盘

环境部署

1. 点我下载环境
2. 解压压缩文件后运行deploy.bat，并根据提示输入必要信息(仅限英文字符)
3. 若批处理正确运行完成，则应在解压目录下生成RUNME.bat
4. 双击RUNME.bat，应打开vscode环境并自动打开仓库目录
5. 现在您可以对仓库进行签出、提交等操作
6. 可能在提交时会提示输入用户名/密码(请输入gitea账户密码)

VSCode-Git 使用说明

1. 在完成环境部署后，vscode中源代码管理功能应可用，从侧边栏中访问该功能

2. 想要对知识库页面进行编辑时，需签出新分支，参考下图步骤

   

Caution

请不要直接对master分支进行修改！ 修改前请签出分支，修改完成后请发起合并分支请求

3. 在进行编辑后点击这里进行推送/发布新分支

Note

想要更加详细了解Git可以参考这篇文档

添加/修改内容

1. 本知识库采用Sphinx作为解析、生成工具，并推荐主要以Markdown语言作为文档的原始语言格式,reStructuredText语言作为辅助
2. source文件夹即为知识库原始文件夹，通过文件树及index.rst进行网页层级管理

Important

请不要修改source/conf.py其为Sphinx配置文件！如需修改请提交PR至管理员

3. 创建文档时：
   1. 请将图片放入_images/目录下，建议单独创建文件夹以保证目录整洁
   2. 其他数据，如：实验数据、日志等，请放入_static/目录下，同样建议创建文件夹以保证目录整洁
   3. 对于新创建的文档：
      1. 如已存在对应目录，则仅需在对应目录下创建文档即可，建议保证文件名具有通俗易懂的可读性
      2. 如不存在目录，则需创建目录及index.rst，并更新上级的index.rst或index.md，具体内容可参考已有文档，如子目录index.rst及父目录index.rst之后新建文档

Note

对于Markdown语法，可以参考这篇文档