# MKB

Manlink Knowledge Base
---
## About
此仓库用于储存及生成知识库网页

[点我访问正式版网页](http://mkb.local)

*[若无法访问，尝试直接访问ip](http://172.18.32.40/)*

---
## Getting Started

### 前期准备
1. 在[这里](http://mkb.local:3000/user/sign_up)注册账号
2. 通知管理员将账户加入`Manlink_Doc` 仓库
3. 确保连接`manlink_internal`网络
4. 确保可以访问公共盘

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

### VSCode-Git 使用说明

1. 在完成环境部署后，vscode中源代码管理功能应可用，从侧边栏中访问该功能
   ![VSCode Git](./source/_images/Readme/vscode_git.png)
2. 想要对知识库页面进行编辑时，需**签出新分支**，参考下图步骤

    ![](./source/_images/Readme/vscode_checkout.png)
    ![](./source/_images/Readme/vscode_new_branch.png)

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

3. 在进行编辑后点击这里进行推送/发布新分支
   ![](./source/_images/Readme/vscode_push.png)