增加文档

使用说明.md

@@ -21,11 +21,13 @@
 ### 方式一：在服务器上直接编辑（推荐用于快速修改）
 
 1. **SSH 连接到服务器**
+   
    ```bash
    ssh renjianbo@101.43.95.130
    ```
 
 2. **编辑文档文件**
+   
    ```bash
    # 使用 vim 编辑
    vim /home/renjianbo/devops/mkdocs/docs/index.md
@@ -35,16 +37,19 @@
    ```
 
 3. **保存文件后，MkDocs 会自动重新加载**（开发模式）
+   
    - 无需重启服务
    - 浏览器刷新即可看到更新
 
 ### 方式二：本地开发后上传（推荐用于大量编辑）
 
 1. **在本地电脑上编辑**
+   
    - 使用你喜欢的编辑器（VS Code、Typora、MarkText 等）
    - 编辑 `docs/` 目录下的 Markdown 文件
 
 2. **上传到服务器**
+   
    ```bash
    # 使用 scp 上传
    scp -r docs/ renjianbo@101.43.95.130:/home/renjianbo/devops/mkdocs/
@@ -58,6 +63,7 @@
 ### 方式三：使用 Git 管理（推荐用于团队协作）
 
 1. **在本地编辑并提交到 Git**
+   
    ```bash
    cd /home/renjianbo/devops/mkdocs
    git add .
@@ -66,6 +72,7 @@
    ```
 
 2. **在服务器上拉取更新**
+   
    ```bash
    ssh renjianbo@101.43.95.130
    cd /home/renjianbo/devops/mkdocs
@@ -100,12 +107,14 @@ docs/
 ### 添加新文档
 
 1. **创建 Markdown 文件**
+   
    ```bash
    # 例如：添加新的学习笔记
    touch /home/renjianbo/devops/mkdocs/docs/学习笔记/新主题.md
    ```
 
 2. **编辑文件内容**
+   
    ```markdown
    # 新主题
    
@@ -113,6 +122,7 @@ docs/
    ```
 
 3. **在 mkdocs.yml 中添加导航**
+   
    ```yaml
    nav:
      - 学习笔记:
@@ -126,11 +136,13 @@ docs/
 ## 🛠️ 常用编辑命令
 
 ### 查看现有文档
+
 ```bash
 ls -la /home/renjianbo/devops/mkdocs/docs/
 ```
 
 ### 编辑文档
+
 ```bash
 # 使用 vim
 vim /home/renjianbo/devops/mkdocs/docs/index.md
@@ -140,6 +152,7 @@ nano /home/renjianbo/devops/mkdocs/docs/index.md
 ```
 
 ### 创建新文档
+
 ```bash
 # 创建新文件
 touch /home/renjianbo/devops/mkdocs/docs/新文档.md
@@ -149,6 +162,7 @@ nano /home/renjianbo/devops/mkdocs/docs/新文档.md
 ```
 
 ### 查看 MkDocs 日志（确认更新）
+
 ```bash
 docker logs -f mkdocs
 ```
@@ -158,6 +172,7 @@ docker logs -f mkdocs
 ### 1. 使用本地编辑器（推荐）
 
 在本地使用专业的 Markdown 编辑器：
+
 - **VS Code** + Markdown 插件
 - **Typora**（所见即所得）
 - **MarkText**（开源免费）
@@ -165,6 +180,7 @@ docker logs -f mkdocs
 ### 2. 实时预览
 
 MkDocs 开发模式支持自动刷新：
+
 - 编辑文件并保存
 - 浏览器会自动刷新显示最新内容
 - 无需手动重启服务
@@ -172,6 +188,7 @@ MkDocs 开发模式支持自动刷新：
 ### 3. 文件同步
 
 如果需要在多台电脑上编辑：
+
 - 使用 Git 管理文档
 - 或使用 rsync/scp 同步文件
 
@@ -180,16 +197,20 @@ MkDocs 开发模式支持自动刷新：
 编辑文件后，可以通过以下方式验证：
 
 1. **查看容器日志**
+   
    ```bash
    docker logs mkdocs | tail -20
    ```
+   
    应该看到类似信息：
+   
    ```
    INFO    -  Documentation built in 1.32 seconds
    INFO    -  [时间] Serving on http://0.0.0.0:8000/
    ```
 
 2. **刷新浏览器**
+   
    - 访问 http://101.43.95.130:8000
    - 按 F5 或 Ctrl+R 刷新
    - 应该看到最新内容
@@ -203,6 +224,7 @@ A: MkDocs 是静态文档生成工具，它读取 Markdown 文件并生成静态
 ### Q: 如果我想在线编辑怎么办？
 
 A: 可以考虑以下方案：
+
 1. **使用 Wiki 系统**（如 Gitea 的 Wiki 功能）
 2. **使用在线 Markdown 编辑器**（如 HackMD、StackEdit）
 3. **使用 Git 工作流**（本地编辑 → Git 提交 → 服务器拉取）
@@ -224,4 +246,3 @@ A: 不需要！MkDocs 开发模式会自动检测文件变化并重新生成网
 ---
 
 **总结：MkDocs 需要编辑 Markdown 文件，不能在前端网站直接编辑。编辑文件后，MkDocs 会自动生成更新的网站。**
-