feat: edit README

ustclug · Jan 22, 2024 · c20f239 · c20f239
1 parent ba6cfc5
commit c20f239
Show file tree

Hide file tree

Showing 6 changed files with 19 additions and 7 deletions.
diff --git a/.gitignore b/.gitignore
@@ -2,3 +2,4 @@
 /env/
 /venv/
 /site/
+node_modules
diff --git a/README.md b/README.md
@@ -1 +1,12 @@
 # Linux 201 进阶教程
+
+## 如何构建？
+
+1. `python3 -m venv venv`
+2. `. venv/bin/activate`
+3. `pip install -r requirements.txt`
+4. `mkdocs serve`
+
+## 许可
+
+本文档以 Creative Commons BY-SA 4.0 协议发布。详情请见 [LICENSE](LICENSE)。
diff --git a/docs/dev/ssh.md b/docs/dev/ssh.md
@@ -62,7 +62,7 @@ SSH 支持三种端口转发：
     注意远程端口转发默认只能监听 localhost。如果要监听其他地址，需要在远程主机的 `sshd_config` 中设置 `GatewayPorts yes`。与另外两种端口转发不同，客户端无法覆盖服务端的 `GatewayPorts` 设定。
 
 - 动态端口转发（**D**ynamic port forwarding）：在本地监听一个端口用作 SOCKS5 代理，将收到的数据转发到远程主机。例如：
-  
+
     ```shell
     ssh -D 1080 example
     ```

diff --git a/docs/index.md b/docs/index.md
@@ -6,5 +6,5 @@ icon: material/heart
 
 欢迎来到 Linux 201 进阶教程，本教程主要面向 Debian 及其衍生发行版（如 Ubuntu 等）的系统运维，因此与传统的 Linux 教程有所不同。
 
-- 作为系统管理员，使用命令行工具是一项基本技能，因此本教程不会介绍图形界面工具
-- 各种软件工具都附带了完善的 man 手册，因此本教程也不会详细介绍所有软件的每个细节
+-   作为系统管理员，使用命令行工具是一项基本技能，因此本教程不会介绍图形界面工具
+-   各种软件工具都附带了完善的 man 手册，因此本教程也不会详细介绍所有软件的每个细节
diff --git a/docs/ops/storage.md b/docs/ops/storage.md
@@ -17,11 +17,11 @@
 关于磁盘规格，在服务器安装时我们主要关心以下几点：
 
 - 磁盘的尺寸（2.5 英寸、3.5 英寸）
-    - 部分手册会将 2.5 英寸的磁盘称为 SFF（Small Form Factor），3.5 英寸的磁盘称为 LFF（Large Form Factor）。
+  - 部分手册会将 2.5 英寸的磁盘称为 SFF（Small Form Factor），3.5 英寸的磁盘称为 LFF（Large Form Factor）。
 - 磁盘的接口与协议（SAS、SATA、NVMe U.2、M.2）
 - 是否与服务器配置兼容：
-    - 部分服务器会有硬盘白名单，只有白名单中的硬盘才能识别。
-    - 使用的硬件 RAID 方案可能会对硬盘接口有要求，例如 SATA 和 SAS 接口的硬盘不能混用。
+  - 部分服务器会有硬盘白名单，只有白名单中的硬盘才能识别。
+  - 使用的硬件 RAID 方案可能会对硬盘接口有要求，例如 SATA 和 SAS 接口的硬盘不能混用。
 
 !!! warning "仔细阅读并确认厂商文档"
 

diff --git a/requirements.txt b/requirements.txt
@@ -1,2 +1,2 @@
 mkdocs>=1.5.3
-mkdocs-material>=9.5.3
+mkdocs-material>=9.5.3