aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFangcat_Dev <f20091219@outlook.com>2026-08-15 07:27:45 +0000
committerFangcat_Dev <f20091219@outlook.com>2026-08-15 07:27:45 +0000
commit63159631ce5845c83f9e6040cee77375df82505a (patch)
treebacd0b0661e473861c033040a383bcdc37e25fe0
parentMerge pull request 'docs: vscode basic' (#7) from Fangcat_Dev/linux-handbook:main into main (diff)
parent添加J4W原则 (diff)
Merge pull request 'docs: advanced' (#8) from Fangcat_Dev/linux-handbook:main into main
Reviewed-on: https://codeberg.org/LinuxCabin/linux-handbook/pulls/8
-rw-r--r--CODE_OF_CONDUCT.md27
-rw-r--r--CONTRIBUTING.md64
-rw-r--r--README.md4
-rw-r--r--docs/advanced/boot_loader.md84
-rw-r--r--docs/advanced/btrfs.md (renamed from docs/concepts/file_system/btrfs.md)2
-rw-r--r--docs/advanced/lvm.md (renamed from docs/concepts/file_system/lvm.md)0
-rw-r--r--docs/concepts/operating_system/boot_loader.md89
-rw-r--r--mkdocs.yml8
8 files changed, 130 insertions, 148 deletions
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
new file mode 100644
index 0000000..5dd281d
--- /dev/null
+++ b/CODE_OF_CONDUCT.md
@@ -0,0 +1,27 @@
+# 贡献准则
+
+## 底线
+
+1. 内容不得违反中华人民共和国法律法规。
+2. 所有引用内容(包括但不限于链接、图片)必须为中国大陆可正常访问的、有效存在的、未过时的资源。
+
+## 内容
+
+1. 对于常见问题,不得纳入冷门、小众的内容(如某机型特定驱动修复、CLOVER引导配置等),一切问题必须是常见的,广泛的,可复现的。
+2. 对于教程,不得出现不常见的或不相关的内容(如C++编译、Synapse搭建方法)。
+3. 对于概念,不得过度涉及系统底层(如PAM、管道)。
+4. 尽可能采用简单的语言阐释,如类比等。
+5. 仅有分离困难或相关性极大的内容允许被合并(如BIOS/UEFI允许,Deepin/统信UOS、Enterprise Linux三巨头不允许)。
+6. 不得出现个人文笔色彩强烈的内容。
+7. 项目尽量遵循J4W原则,即Just4Work,指文档必须在必须的,无法避免的,影响日常的且新手需要的,可以理解的方面撰写。
+8. 除笔误、拼写错误相关外,所有提交必须经过PR与审查流程,由Reviewers审查。
+9. 允许AI生成内容,但必须经过人工实机核查。
+
+## 格式
+
+1. 已经有Template的栏目请严格遵照模板,无模板栏目请参考先前已有文章文体格式。
+2. 对于包名、指令名、单行代码请使用行内代码;对于多行代码,请使用块级代码。
+3. 所有内链禁止使用硬编码,请链接到相应.md文件。
+4. 合理使用[Admonitions](https://squidfunk.github.io/mkdocs-material/reference/admonitions/)。
+5. 提交前请务必检查内容能否正常渲染与展示。
+
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 74c8ce5..d4053a9 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,35 +1,6 @@
-贡献者,你好!
+# 贡献指南
-感谢您对本项目做出的支持!以下是一些注意事项。
-
-## 在哪里贡献?
-
-您可以通过提Issues,或者发起PR (Pull Request) 的方式来贡献。在贡献时,我们建议您将负责人设置为LinuxCabin的一位管理成员以更快处理您的请求。
-
-下面是一个可供参考的模板:
-
-```
-我希望增加内容的标题: The Title
-这个内容应被放置/追加在:Chapter-Another Chapter章节
-
-章节内容:
-
-xxxxxx
-
-```
-
-若您的内容被退回,建议您仔细阅读退回原因。如果经过修改没有问题,我们允许您再次提交。
-
-### 我们不建议您贡献的内容
-
-- 与Linux无关的内容
-- 专业性过高的内容
-- 偏颇/太过不常见的内容(如果值得商讨您也可以贡献)
-- 由AIGC生成的内容(经由人工审核且确认无误的情况除外)
-
-## PR贡献的工作流?
-
-### 安装必要依赖
+## 安装必要依赖
请确保您的电脑已经安装了最新版的Python,并被添加到PATH中。
@@ -39,21 +10,22 @@ xxxxxx
pip install -r requirements.txt
```
-(注:为防止python3安装的依赖污染系统环境导致系统不稳定,建议[创建venv虚拟环境](#venv虚拟环境))
-
### venv虚拟环境
-#### 如果您直接使用python
+为防止Python 3安装的依赖污染系统环境导致系统不稳定,建议您创建venv虚拟环境。
+
+#### 直接使用Python
+
```
python -m venv .venv
-source .venv/bin/active
+source .venv/bin/activate
pip install -r requirements.txt
```
#### uv
```
uv venv
-source .venv/bin/active
+source .venv/bin/activate
uv pip install -r requirements.txt
```
@@ -69,22 +41,4 @@ uv pip install -r requirements.txt
mkdocs serve
```
-> 或者你可以直接在 `pending` 目录下新建一个目录,然后存放你的文档,管理员会将它放到正确的地方(如果审核通过的话)
-
-## 贡献时要符合什么规定?
-
-### 总体
-
-1. 所有内容**必须符合中华人民共和国法律**,不得出现涉政、色情、赌毒等内容。
-2. 部分内容需按照templates下的**模板**进行填写,允许在下方追加内容。
-3. 媒体资源建议引用**中国大陆用户能够正常访问**的资源。
-4. 我们建议引用链接为**简体中文官方内容**。
-5. 我们建议所有内容用尽可能简单的语言进行阐释。
-
-### 发行版
-
-1. 请不要将多个发行版合并到一篇文章中。
-2. 衍生发行版不应被置于父发行版的“风味”部分,而应单开一页。
-3. **请确保镜像源以及换源教程地址存在。**
-
-再次感谢您的理解!
+如果您的内容难以分类,你可以在 `pending` 目录下新建一个目录,然后存放你的文档,管理员会将它放到正确的地方。
diff --git a/README.md b/README.md
index b0444ef..4247ea4 100644
--- a/README.md
+++ b/README.md
@@ -13,7 +13,7 @@
## 我们想要做什么?
-众所周知,当前中文互联网Linux教程纷繁复杂,并且大多不适合新手入门,因而,我们希望有一个教程,能够尽可能地涵盖更多发行版与更多新手的常见问题,而不过度涉及系统底层。
+众所周知,当前中文互联网Linux教程纷繁复杂,并且大多不适合新手入门与学习。因而,我们希望有一个教程,能够尽可能地涵盖更多发行版与更多新手的教程与常见问题,而不过度涉及系统底层。
## 我们面向谁?
@@ -27,7 +27,7 @@ LinuxCabin是一个志愿者组织,本教程由对Linux抱有热情的用户æ’
我们广泛欢迎各位志愿者贡献文档。
-贡献前必看:[CONTRIBUTING.md](CONTRIBUTING.md)
+贡献前必看:[CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) 与 [CONTRIBUTING.md](CONTRIBUTING.md)
## 项目架构
diff --git a/docs/advanced/boot_loader.md b/docs/advanced/boot_loader.md
new file mode 100644
index 0000000..de4d7cf
--- /dev/null
+++ b/docs/advanced/boot_loader.md
@@ -0,0 +1,84 @@
+# 引导美化
+
+## GRUB
+
+一般来说,多数Linux发行版预装GRUB作为引导器。它非常强大和灵活,能够理解文件系统和内核可执行文件格式。
+
+### 美化
+
+[GNOME-LOOK.ORG](https://www.gnome-look.org/browse?cat=109)与[Github](https://github.com/topics/grub-theme)上均有丰富多样的GRUB主题。
+
+一些主题拥有一键安装脚本,您也可以手动安装——在下载好压缩包后,您需要将其解压到文件夹中,并放置到GRUB的主题目录中。大多数发行版的目录为`/boot/grub/themes`,部分发行版为`/boot/grub2/themes`或其他目录。
+
+之后,您需要编辑GRUB配置文件(`sudo nano /etc/default/grub`),找到以`#GRUB_THEME`开头的一行,将其替换为:
+```bash
+GRUB_THEME=/boot/grub/themes/主题文件夹/theme.txt
+# 一般为theme.txt,部分主题可能不同
+```
+
+最后,运行`sudo upgrade-grub`来更新GRUB配置即可。
+
+## rEFInd
+
+rEFInd是作为已停止维护的rEFIt项目的分支而诞生,最初旨在解决非Mac电脑上的UEFI启动问题。它的最大亮点是自动检测能力,能自动识别出系统里的Windows、Linux、macOS等各种操作系统。由于其出色的外观和易用性,它在需要管理复杂多系统启动的用户中非常受欢迎。
+
+!!! warning "适用性"
+ rEFInd仅支持UEFI。
+
+### 安装
+
+您需要通过您的包管理器安装`refind` (Debian/Arch) / `rEFInd` (Fedora,注意大小写)。
+
+在安装软件包之后,您需要运行`sudo refind-install`来将其安装到ESP。
+
+安装之后,您需要关闭或手动配置[安全启动](../concepts/operating_system/secure_boot.md)来保证引导器正常运行。以下我们会示范如何使用shim配置。
+
+首先,您需要通过您的包管理器安装`shim-signed`。
+
+大部分发行版已经预置了签名过的shimx64.efi,您只需要替换以下指令`--shim`后的路径即可。
+
+```bash
+sudo refind install --shim /boot/efi/一般为发行版名称/shimx64.efi
+# EFI目录可能存在差异
+# 或者,您也可以使用/usr/share/shim-signed/shimx64.efi
+```
+
+重启电脑后,您会进入MOK Manager界面。
+
+![Access Denied](https://www.091209.xyz/wp-content/uploads/2025/07/image-2.png)
+
+![MOK management](https://www.091209.xyz/wp-content/uploads/2025/07/image-3.png)
+
+请选择OK=>Enroll hash from disk,找到`refind_x64.efi`,OK=>Reboot重启即可。
+
+更多选项,建议您参考[Arch Wiki](https://wiki.archlinuxcn.org/wiki/REFInd)。
+
+!!! warning "警告"
+ 我们不建议您在安装rEFInd之后贸然卸载GRUB。rEFInd的识别能力有限,若您在安装系统时选择单独分区`/boot`则**可能无法直接通过vmlinuz绕过GRUB启动**。
+
+ 在部分发行版内,GRUB可能受包管理器保护。
+
+ ??? note "卸载GRUB"
+ 此处以Fedora为例。要卸载GRUB,首先需要移除系统对GRUB包的保护。
+
+ ```bash
+ sudo rm /etc/dnf/protected.d/{shim,grub2*}.conf
+ ```
+
+ 之后,移除GRUB。
+
+ ```bash
+ sudo dnf remove grub* shim*
+ ```
+
+### 美化
+
+rEFInd的主题大多于[Github](https://github.com/topics/refind-theme)上发布。
+
+大多数主题拥有一键安装脚本,并提供了手动安装教程。此处只讲解通用的手动安装方法。
+
+首先,请在`/boot/efi/refind`下创建`themes`文件夹,并将主题压缩包解压到一个文件夹后放置于`themes`下。
+
+之后,请编辑`/boot/efi/refind/refind.conf`,添加`include themes/主题文件夹名/theme.conf`行,并删除其他类似主题配置行。
+
+要编辑主题的各项自定义选项,请编辑主题文件夹下的`theme.conf`。
diff --git a/docs/concepts/file_system/btrfs.md b/docs/advanced/btrfs.md
index fb62499..9815417 100644
--- a/docs/concepts/file_system/btrfs.md
+++ b/docs/advanced/btrfs.md
@@ -9,7 +9,7 @@ Btrfs即B-tree文件系统,通常念成Butter FS,Better FS或B-tree FS,一
???+ note "写时复制 (CoW)"
写时复制指将修改的数据块单独存储到CoW分区,以实现备份的作用。具体原理可参考下图。
- ![CoW 示意图](../../img/CoW.png)
+ ![CoW 示意图](../img/CoW.png)
Btrfs有以下常见功能:
diff --git a/docs/concepts/file_system/lvm.md b/docs/advanced/lvm.md
index d145b0f..d145b0f 100644
--- a/docs/concepts/file_system/lvm.md
+++ b/docs/advanced/lvm.md
diff --git a/docs/concepts/operating_system/boot_loader.md b/docs/concepts/operating_system/boot_loader.md
index 722bddb..64bdb78 100644
--- a/docs/concepts/operating_system/boot_loader.md
+++ b/docs/concepts/operating_system/boot_loader.md
@@ -6,6 +6,8 @@
引导是计算机启动时,[BIOS/UEFI](./bios.md)用来寻找并启动操作系统的程序。通常情况下,引导文件为efi格式,并统一存储在ESP分区(一般来说是磁盘分区图最靠左的不大的FAT32分区)中。
+大多数Linux发行版使用GRUB作为引导。要美化引导,请参阅[引导美化](../../advanced/boot_loader.md)。
+
???+ note "一般ESP分区的结构"
**ESP目录结构可能因挂载点不同存在差异,请自行替换下方教程路径。**
@@ -33,89 +35,4 @@
├── bootuuid.cfg
  ├── grub.cfg
   └── grubenv
- ```
-
-## 引导器
-
-### GRUB
-
-一般来说,多数Linux发行版预装GRUB作为引导器。它非常强大和灵活,能够理解文件系统和内核可执行文件格式。
-
-#### 美化
-
-[GNOME-LOOK.ORG](https://www.gnome-look.org/browse?cat=109)与[Github](https://github.com/topics/grub-theme)上均有丰富多样的GRUB主题。
-
-一些主题拥有一键安装脚本,您也可以手动安装——在下载好压缩包后,您需要将其解压到文件夹中,并放置到GRUB的主题目录中。大多数发行版的目录为`/boot/grub/themes`,部分发行版为`/boot/grub2/themes`或其他目录。
-
-之后,您需要编辑GRUB配置文件(`sudo nano /etc/default/grub`),找到以`#GRUB_THEME`开头的一行,将其替换为:
-```bash
-GRUB_THEME=/boot/grub/themes/主题文件夹/theme.txt
-# 一般为theme.txt,部分主题可能不同
-```
-
-最后,运行`sudo upgrade-grub`来更新GRUB配置即可。
-
-### rEFInd
-
-rEFInd是作为已停止维护的rEFIt项目的分支而诞生,最初旨在解决非Mac电脑上的UEFI启动问题。它的最大亮点是自动检测能力,能自动识别出系统里的Windows、Linux、macOS等各种操作系统。由于其出色的外观和易用性,它在需要管理复杂多系统启动的用户中非常受欢迎。
-
-!!! warning "适用性"
- rEFInd仅支持UEFI。
-
-#### 安装
-
-您需要通过您的包管理器安装`refind` (Debian/Arch) / `rEFInd` (Fedora,注意大小写)。
-
-在安装软件包之后,您需要运行`sudo refind-install`来将其安装到ESP。
-
-安装之后,您需要关闭或手动配置[安全启动](./secure_boot.md)来保证引导器正常运行。以下我们会示范如何使用shim配置。
-
-首先,您需要通过您的包管理器安装`shim-signed`。
-
-大部分发行版已经预置了签名过的shimx64.efi,您只需要替换以下指令`--shim`后的路径即可。
-
-```bash
-sudo refind install --shim /boot/efi/一般为发行版名称/shimx64.efi
-# EFI目录可能存在差异
-# 或者,您也可以使用/usr/share/shim-signed/shimx64.efi
-```
-
-重启电脑后,您会进入MOK Manager界面。
-
-![Access Denied](https://www.091209.xyz/wp-content/uploads/2025/07/image-2.png)
-
-![MOK management](https://www.091209.xyz/wp-content/uploads/2025/07/image-3.png)
-
-请选择OK=>Enroll hash from disk,找到`refind_x64.efi`,OK=>Reboot重启即可。
-
-更多选项,建议您参考[Arch Wiki](https://wiki.archlinuxcn.org/wiki/REFInd)。
-
-!!! warning "警告"
- 我们不建议您在安装rEFInd之后贸然卸载GRUB。rEFInd的识别能力有限,若您在安装系统时选择单独分区`/boot`则**可能无法直接通过vmlinuz绕过GRUB启动**。
-
- 在部分发行版内,GRUB可能受包管理器保护。
-
- ??? note "卸载GRUB"
- 此处以Fedora为例。要卸载GRUB,首先需要移除系统对GRUB包的保护。
-
- ```bash
- sudo rm /etc/dnf/protected.d/{shim,grub2*}.conf
- ```
-
- 之后,移除GRUB。
-
- ```bash
- sudo dnf remove grub* shim*
- ```
-
-#### 美化
-
-rEFInd的主题大多于[Github](https://github.com/topics/refind-theme)上发布。
-
-大多数主题拥有一键安装脚本,并提供了手动安装教程。此处只讲解通用的手动安装方法。
-
-首先,请在`/boot/efi/refind`下创建`themes`文件夹,并将主题压缩包解压到一个文件夹后放置于`themes`下。
-
-之后,请编辑`/boot/efi/refind/refind.conf`,添加`include themes/主题文件夹名/theme.conf`行,并删除其他类似主题配置行。
-
-要编辑主题的各项自定义选项,请编辑主题文件夹下的`theme.conf`。
+ ``` \ No newline at end of file
diff --git a/mkdocs.yml b/mkdocs.yml
index 3f708ba..58be04a 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -132,9 +132,6 @@ nav:
- concepts/package_managers/pacman.md
- concepts/package_managers/flatpak.md
- concepts/package_managers/appimage.md
- - 文件系统:
- - concepts/file_system/lvm.md
- - concepts/file_system/btrfs.md
- 桌面:
- concepts/desktop/de.md
- concepts/desktop/tiling_desktop.md
@@ -190,5 +187,8 @@ nav:
- applications/programming/python.md
- applications/programming/miniconda.md
- applications/programming/vscode.md
- #- 进阶:
+ - 进阶:
+ - advanced/lvm.md
+ - advanced/btrfs.md
+ - advanced/boot_loader.md
- 关于: about.md