diff options
| -rw-r--r-- | .forgejo/workflows/mkdocs-deploy.yml | 9 | ||||
| -rw-r--r-- | CODE_OF_CONDUCT.md | 27 | ||||
| -rw-r--r-- | CONTRIBUTING.md | 64 | ||||
| -rw-r--r-- | README.md | 10 | ||||
| -rw-r--r-- | docs/advanced/.gitkeep | 0 | ||||
| -rw-r--r-- | docs/advanced/boot_loader.md | 84 | ||||
| -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/applications/programming/vscode.md | 42 | ||||
| -rw-r--r-- | docs/concepts/operating_system/boot_loader.md | 89 | ||||
| -rw-r--r-- | docs/index.md | 6 | ||||
| -rw-r--r-- | images/flowchart.png | bin | 0 -> 171807 bytes | |||
| -rw-r--r-- | mkdocs.yml | 8 |
13 files changed, 183 insertions, 158 deletions
diff --git a/.forgejo/workflows/mkdocs-deploy.yml b/.forgejo/workflows/mkdocs-deploy.yml index 473ff14..417b1f3 100644 --- a/.forgejo/workflows/mkdocs-deploy.yml +++ b/.forgejo/workflows/mkdocs-deploy.yml @@ -29,6 +29,7 @@ concurrency: jobs: build-and-deploy: runs-on: build-env + # Using nikolaik/python-nodejs:python3.14-nodejs26 to avoid the setup conflict between Python and Node.js steps: - name: Checkout source code uses: https://gitea.cn/actions/checkout@v4 @@ -49,15 +50,13 @@ jobs: - name: Deploy to target repository if: github.event_name == 'push' || github.event_name == 'workflow_dispatch' env: - TARGET_REPO: https://codeberg.org/LinuxCabin/handbook-site - TARGET_BRANCH: pages DEPLOY_TOKEN: ${{ secrets.DEPLOY_TOKEN }} run: | cd site echo "hb.linuxcabin.top" > CNAME git init - git config user.name "${{ github.actor }}" - git config user.email "${{ github.actor }}@noreply.codeberg.org" + git config user.name "Fangcat_Dev" + git config user.email "f20091219@outlook.com" git add . git commit -m "Deploy site $(date -u '+%Y-%m-%d %H:%M:%S UTC')" - git push --force https://x-access-token:${DEPLOY_TOKEN}@${TARGET_REPO#https://} HEAD:${TARGET_BRANCH}
\ No newline at end of file + git push --force "https://Fangcat_Dev:${DEPLOY_TOKEN}@codeberg.org/LinuxCabin/handbook-site.git" HEAD:pages
\ No newline at end of file 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` 目录下新建一个目录,然后存放你的文档,管理员会将它放到正确的地方。 @@ -13,7 +13,7 @@ ## 我们想要做什么? -众所周知,当前中文互联网Linux教程纷繁复杂,并且大多不适合新手入门,因而,我们希望有一个教程,能够尽可能地涵盖更多发行版与更多新手的常见问题,而不过度涉及系统底层。 +众所周知,当前中文互联网Linux教程纷繁复杂,并且大多不适合新手入门与学习。因而,我们希望有一个教程,能够尽可能地涵盖更多发行版与更多新手的教程与常见问题,而不过度涉及系统底层。 ## 我们面向谁? @@ -27,10 +27,8 @@ LinuxCabin是一个志愿者组织,本教程由对Linux抱有热情的用户æ’ 我们广泛欢迎各位志愿者贡献文档。 -贡献前必看:[CONTRIBUTING.md](CONTRIBUTING.md) +贡献前必看:[CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) 与 [CONTRIBUTING.md](CONTRIBUTING.md) -## 贡献者们 +## 项目架构 -<a href="https://github.com/LinuxCabin/linux-handbook/graphs/contributors"> - <img src="https://contrib.rocks/image?repo=LinuxCabin/linux-handbook" /> -</a> +
\ No newline at end of file diff --git a/docs/advanced/.gitkeep b/docs/advanced/.gitkeep new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/docs/advanced/.gitkeep 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界面。 + + + + + +请选择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分区,以实现备份的作用。具体原理可参考下图。 -  +  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/applications/programming/vscode.md b/docs/applications/programming/vscode.md new file mode 100644 index 0000000..8408cb0 --- /dev/null +++ b/docs/applications/programming/vscode.md @@ -0,0 +1,42 @@ +# VS Code / VSCodium + +全称: Visual Studio Code + +## 概述 + +Visual Studio Code是由微软开发的开源IDE,因其庞大的扩展市场与广泛的语言支持而闻名,多数的在线IDE基于VSCode二次开发。VSCodium为VSCode的自由版本,削减了微软提供的遥测等服务,不收集用户数据。 + +???+ question "VSCodium为什么被称作“自由版本”?" + 尽管微软将VSCode的核心代码开源,但诸如扩展市场、同步等功能仍然闭源且由微软掌控,仅仅在微软进行编译时被加入源代码。 + + + +## 安装 + +!!! warning "警告" + 我们**不推荐您安装该应用的Flatpak版本**。由于Flatpak的容器特性,宿主机的部分开发工具可能需要[特殊处理](https://github.com/flathub/com.visualstudio.code#usage)后才能在Flatpak容器内部使用。 + +### VSCode + +微软官方提供了[Linux版的安装教程](https://code.visualstudio.com/docs/setup/linux),该教程主要通过添加微软官方软件源的方式来进行安装。您也可以到[VSCode官网](https://code.visualstudio.com/)下载预编译包来安装。社区也构建了其[Flatpak版本](https://flathub.org/zh-Hans/apps/com.visualstudio.code)。 + +Arch用户可以通过AUR安装`visual-studio-code-bin`。 + +同时,微软还提供了[网页版VSCode](https://vscode.dev),在功能上可能略有损失。 + +### VSCodium + +您需要手动前往VSCodium的[Github Releases](https://github.com/VSCodium/vscodium/releases)页面下载安装包,或者使用[Flatpak](https://flathub.org/zh-Hans/apps/com.vscodium.codium)安装。 + +Arch用户可以通过AUR安装`vscodium-bin`。 + +## 使用 + +您可以按下`Ctrl+Shift+P`打开功能面板,进行打开终端、切换语言、预览Markdown等操作。 + +### 扩展 + +VSCode的扩展市场涵盖编程语言支持、界面语言支持、IDE插件、界面主题等等扩展(一切皆扩展),您可以根据自己的工作情况按需安装。 + +???+ note "本地化" + 对于中文用户来说,您可能需要安装[中文(简体)界面语言包](https://marketplace.visualstudio.com/items?itemName=MS-CEINTL.vscode-language-pack-zh-hans)。 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界面。 - - - - - -请选择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/docs/index.md b/docs/index.md index 2a55dda..9f4f24b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -6,8 +6,10 @@ 访问慢?换条线路试试!😉 - - [Github Pages](https://hb.091209.xyz) - - [Vercel](https://vercel.hb.091209.xyz) + - [Vercel](https://vercel.hb.linuxcabin.top) + - [Github Pages](https://hb.linuxcabin.top) + - [Codeberg Pages](https://cb.hb.linuxcabin.top) + - [Cloudflare Pages](https://cf.hb.linuxcabin.top) ## 想要入门?看这里! diff --git a/images/flowchart.png b/images/flowchart.png Binary files differnew file mode 100644 index 0000000..4a1f749 --- /dev/null +++ b/images/flowchart.png @@ -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 @@ -189,4 +186,9 @@ nav: - applications/programming/cpp.md - applications/programming/python.md - applications/programming/miniconda.md + - applications/programming/vscode.md + - 进阶: + - advanced/lvm.md + - advanced/btrfs.md + - advanced/boot_loader.md - 关于: about.md |
