diff options
| -rw-r--r-- | .github/workflows/mkdocs-deploy.yml | 58 | ||||
| -rw-r--r-- | CONTRIBUTE.md | 0 | ||||
| -rw-r--r-- | LICENSE (renamed from LICENSE.md) | 62 | ||||
| -rw-r--r-- | README.md | 6 | ||||
| -rw-r--r-- | docs/about.md | 15 | ||||
| -rw-r--r-- | docs/distros/debian/ubuntu.md | 46 | ||||
| -rw-r--r-- | docs/distros/rhel/fedora.md | 69 | ||||
| -rw-r--r-- | docs/getting-started/before-installing.md | 34 | ||||
| -rw-r--r-- | docs/getting-started/purpose.md | 16 | ||||
| -rw-r--r-- | docs/index.md | 6 | ||||
| -rw-r--r-- | images/LC.png | bin | 0 -> 59899 bytes | |||
| -rw-r--r-- | mkdocs.yml | 23 | ||||
| -rw-r--r-- | templates/concept.md | 18 | ||||
| -rw-r--r-- | templates/distro.md | 33 |
14 files changed, 340 insertions, 46 deletions
diff --git a/.github/workflows/mkdocs-deploy.yml b/.github/workflows/mkdocs-deploy.yml new file mode 100644 index 0000000..01ef5ac --- /dev/null +++ b/.github/workflows/mkdocs-deploy.yml @@ -0,0 +1,58 @@ +name: Deploy MkDocs to GitHub + +on: + # 推送到 main 分支时自动触发 + push: + branches: + - main + paths: + - 'docs/**' + - 'mkdocs.yml' + - '.github/workflows/mkdocs-deploy.yml' + + # 支持手动触发 + workflow_dispatch: + +permissions: + contents: read + pages: write + id-token: write + +jobs: + build-and-deploy: + runs-on: ubuntu-latest + steps: + - name: Checkout 源码 + uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: 设置 Python 环境 + uses: actions/setup-python@v5 + with: + python-version: '3.13' + cache: 'pip' + + - name: 安装 MkDocs 及依赖 + run: | + python -m pip install --upgrade pip + pip install mkdocs mkdocs-material + + - name: 构建 MkDocs 站点 + run: mkdocs build + + - name: 推送到目标仓库 + uses: peaceiris/actions-gh-pages@v4 + with: + # 目标仓库地址,格式:用户名/仓库名 + deploy_key: ${{ secrets.DEPLOY_KEY }} + external_repository: LinuxCabin/handbook-website + # 目标仓库的分支 + publish_branch: main + # 构建产物目录 + publish_dir: ./site + # 保留目标分支的历史提交(可选) + keep_files: false + # 提交用户信息 + user_name: 'github-actions[bot]' + user_email: 'github-actions[bot]@users.noreply.github.com' diff --git a/CONTRIBUTE.md b/CONTRIBUTE.md new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/CONTRIBUTE.md @@ -1,4 +1,4 @@ -Attribution-NonCommercial 4.0 International +Attribution-NonCommercial-NoDerivatives 4.0 International ======================================================================= @@ -54,18 +54,18 @@ exhaustive, and do not form part of our licenses. ======================================================================= -Creative Commons Attribution-NonCommercial 4.0 International Public -License +Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 +International Public License By exercising the Licensed Rights (defined below), You accept and agree to be bound by the terms and conditions of this Creative Commons -Attribution-NonCommercial 4.0 International Public License ("Public -License"). To the extent this Public License may be interpreted as a -contract, You are granted the Licensed Rights in consideration of Your -acceptance of these terms and conditions, and the Licensor grants You -such rights in consideration of benefits the Licensor receives from -making the Licensed Material available under these terms and -conditions. +Attribution-NonCommercial-NoDerivatives 4.0 International Public +License ("Public License"). To the extent this Public License may be +interpreted as a contract, You are granted the Licensed Rights in +consideration of Your acceptance of these terms and conditions, and the +Licensor grants You such rights in consideration of benefits the +Licensor receives from making the Licensed Material available under +these terms and conditions. Section 1 -- Definitions. @@ -80,40 +80,37 @@ Section 1 -- Definitions. Adapted Material is always produced where the Licensed Material is synched in timed relation with a moving image. - b. Adapter's License means the license You apply to Your Copyright - and Similar Rights in Your contributions to Adapted Material in - accordance with the terms and conditions of this Public License. - - c. Copyright and Similar Rights means copyright and/or similar rights + b. Copyright and Similar Rights means copyright and/or similar rights closely related to copyright including, without limitation, performance, broadcast, sound recording, and Sui Generis Database Rights, without regard to how the rights are labeled or categorized. For purposes of this Public License, the rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights. - d. Effective Technological Measures means those measures that, in the + + c. Effective Technological Measures means those measures that, in the absence of proper authority, may not be circumvented under laws fulfilling obligations under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, and/or similar international agreements. - e. Exceptions and Limitations means fair use, fair dealing, and/or + d. Exceptions and Limitations means fair use, fair dealing, and/or any other exception or limitation to Copyright and Similar Rights that applies to Your use of the Licensed Material. - f. Licensed Material means the artistic or literary work, database, + e. Licensed Material means the artistic or literary work, database, or other material to which the Licensor applied this Public License. - g. Licensed Rights means the rights granted to You subject to the + f. Licensed Rights means the rights granted to You subject to the terms and conditions of this Public License, which are limited to all Copyright and Similar Rights that apply to Your use of the Licensed Material and that the Licensor has authority to license. - h. Licensor means the individual(s) or entity(ies) granting rights + g. Licensor means the individual(s) or entity(ies) granting rights under this Public License. - i. NonCommercial means not primarily intended for or directed towards + h. NonCommercial means not primarily intended for or directed towards commercial advantage or monetary compensation. For purposes of this Public License, the exchange of the Licensed Material for other material subject to Copyright and Similar Rights by digital @@ -121,7 +118,7 @@ Section 1 -- Definitions. no payment of monetary compensation in connection with the exchange. - j. Share means to provide material to the public by any means or + i. Share means to provide material to the public by any means or process that requires permission under the Licensed Rights, such as reproduction, public display, public performance, distribution, dissemination, communication, or importation, and to make material @@ -129,13 +126,13 @@ Section 1 -- Definitions. public may access the material from a place and at a time individually chosen by them. - k. Sui Generis Database Rights means rights other than copyright + j. Sui Generis Database Rights means rights other than copyright resulting from Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, as amended and/or succeeded, as well as other essentially equivalent rights anywhere in the world. - l. You means the individual or entity exercising the Licensed Rights + k. You means the individual or entity exercising the Licensed Rights under this Public License. Your has a corresponding meaning. @@ -151,8 +148,8 @@ Section 2 -- Scope. a. reproduce and Share the Licensed Material, in whole or in part, for NonCommercial purposes only; and - b. produce, reproduce, and Share Adapted Material for - NonCommercial purposes only. + b. produce and reproduce, but not Share, Adapted Material + for NonCommercial purposes only. 2. Exceptions and Limitations. For the avoidance of doubt, where Exceptions and Limitations apply to Your use, this Public @@ -226,8 +223,7 @@ following conditions. a. Attribution. - 1. If You Share the Licensed Material (including in modified - form), You must: + 1. If You Share the Licensed Material, You must: a. retain the following if it is supplied by the Licensor with the Licensed Material: @@ -255,6 +251,9 @@ following conditions. Public License, and include the text of, or the URI or hyperlink to, this Public License. + For the avoidance of doubt, You do not have permission under + this Public License to Share Adapted Material. + 2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner based on the medium, means, and context in which You Share the Licensed Material. For example, it may be @@ -266,10 +265,6 @@ following conditions. information required by Section 3(a)(1)(A) to the extent reasonably practicable. - 4. If You Share Adapted Material You produce, the Adapter's - License You apply must not prevent recipients of the Adapted - Material from complying with this Public License. - Section 4 -- Sui Generis Database Rights. @@ -279,7 +274,7 @@ apply to Your use of the Licensed Material: a. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, reuse, reproduce, and Share all or a substantial portion of the contents of the database for NonCommercial purposes - only; + only and provided You do not Share Adapted Material; b. if You include all or a substantial portion of the database contents in a database in which You have Sui Generis Database @@ -405,4 +400,3 @@ the avoidance of doubt, this paragraph does not form part of the public licenses. Creative Commons may be contacted at creativecommons.org. - @@ -1,5 +1,7 @@ -# LinuxCabin +# LinuxCabin Handbook -嘿!你好👋这是LinuxCabin,一个专为中国用户设计的Linux入门指南! + + +嘿!你好👋这是LinuxCabin Handbook,一个专为中国用户设计的Linux入门指南! **本项目目前处于未完成状态,欢迎贡献!** diff --git a/docs/about.md b/docs/about.md index 7cd0964..e2bdb1e 100644 --- a/docs/about.md +++ b/docs/about.md @@ -5,16 +5,17 @@ LinuxCabin是由[@Fangcat_Dev](https://space.bilibili.com/588672425)与[@13-trix 项目目前处于未完成状态,各位敬请期待! ## 联系方式 - - Fangcat_Dev + +### Fangcat_Dev - QQ: 2950966704 +QQ: 2950966704 - Matrix: @fangcat-dev:fedora.im +Matrix: @fangcat-dev:fedora.im - E-Mail: [f20091219@outlook.com](mailto:f20091219@outlook.com) +E-Mail: [f20091219@outlook.com](mailto:f20091219@outlook.com) - - 13-trixie +### 13-trixie - QQ: 1513463007 +QQ: 1513463007 - Matrix: @13-trixie:matrix.org
\ No newline at end of file +Matrix: @13-trixie:matrix.org
\ No newline at end of file diff --git a/docs/distros/debian/ubuntu.md b/docs/distros/debian/ubuntu.md new file mode 100644 index 0000000..46c937e --- /dev/null +++ b/docs/distros/debian/ubuntu.md @@ -0,0 +1,46 @@ +# Ubuntu + + + +## 简介 + +Ubuntu是当今最受认可的Linux发行版,也是中国国家操作系统基准架构。它用户支持广泛,兼容性强,并且有优秀的开箱即用体验。不过近年来的商业化操作令Linux社区对它嗤之以鼻。 + +## 详细信息 + + - 派系:Debian系 + - 发行者:Canonical + - 官网:https://ubuntu.com/ + - 支持的系统架构:x86_64/arm64 + - 自由软件:是 + - 镜像下载地址: + - - TUNA: https://mirrors.tuna.tsinghua.edu.cn/ubuntu-cdimage/ + - - USTC: https://mirrors.ustc.edu.cn/ubuntu-cdimage/ + - - CERNET: https://mirrors.cernet.edu.cn/ubuntu-cdimage/ + - 包管理器:apt + > 注意!使用apt安装部分软件时可能[被Snap劫持](https://www.zhihu.com/question/47659130)! + - 更新方式:传统 + - 换源教程: + - - TUNA: https://mirrors.tuna.tsinghua.edu.cn/help/ubuntu-ports/ + - - USTC: https://mirrors.ustc.edu.cn/help/ubuntu-ports.html + - - CERNET: https://help.mirrors.cernet.edu.cn/ubuntu-ports/ + +## 风味 + +### Desktop + - Edubuntu: 教育 + - Kubuntu: 预装KDE桌面 + - Lubuntu: 预装LXQt桌面 + - Ubuntu Budgie: 预装Budgie桌面 + - Ubuntu Cinnamon: 预装Cinnamon桌面 + - Ubuntu Kylin(优麒麟): 中国特供版,预装UKUI桌面 + - Ubuntu Studio: 内容创作 + - Ubuntu Unity: 预装Unity桌面 + - Xubuntu: 预装Xfce桌面 + +### Server + - Ubuntu Server: 服务器用系统 + +### Core + - Ubuntu Core: 不可变系统,适合IoT设备 + diff --git a/docs/distros/rhel/fedora.md b/docs/distros/rhel/fedora.md new file mode 100644 index 0000000..0210cbe --- /dev/null +++ b/docs/distros/rhel/fedora.md @@ -0,0 +1,69 @@ +# Fedora + + + +## 简介 + +Fedora是一款前沿、开放的发行版,有着广泛的社区支持,并且提供多种变体可供选择。 + +## 详细信息 + + - 派系:红帽系 + - 发行者:Fedora + - 官网:https://fedoraproject.org/ + - 支持的系统架构:x86_64/arm64 + - 自由软件:是 + - 镜像下载地址: + - - TUNA: https://mirrors.tuna.tsinghua.edu.cn/fedora/releases/ + - - USTC: https://mirrors.ustc.edu.cn/fedora/releases/ + - - CERNET: https://mirrors.cernet.edu.cn/fedora/releases/ + - 包管理器:dnf + - 更新方式:传统 + - 换源教程: + - - TUNA: https://mirrors.tuna.tsinghua.edu.cn/help/fedora/ + - - USTC: https://mirrors.ustc.edu.cn/help/fedora.html + - - CERNET: https://help.mirrors.cernet.edu.cn/fedora/ + +## 风味 + +### Editions + + - Fedora Workstation: 预装GNOME桌面 + - Fedora KDE Plasma Desktop: 预装KDE桌面 + - Fedora Server: 服务器版本 + - Fedora Cloud: 云虚拟机版本 + - Fedora IoT: 嵌入式设备版本 + - Fedora CoreOS: 容器用不可变版本 + +### Atomic Desktops (原子系统) + + - Fedora Silverblue: 预装GNOME桌面,不可变系统 + - Fedora Kinoite: 预装KDE桌面,不可变系统 + - Fedora Sway Atomic: 预装Sway桌面,不可变系统 + - Fedora Budgie Atomic: 预装Budgie桌面,不可变系统 + - Fedora COSMIC Atomic: 预装COSMIC桌面,不可变系统 + +### Spins(预装不同桌面的变体) + + - Xfce Desktop + - Cinnamon Desktop + - MATE+Compiz Desktop + - i3 Tiling WM + - LXQt Desktop + - LXDE Desktop + - SOAS Desktop + - Sway Tiling WM + - Budgie Desktop + - Miracle Desktop + - KDE Mobile Desktop + - COSMIC Desktop + +### Labs(行业特供) + + - Astronomy: 天文 + - Design Suite: 设计 + - Games: 游戏 + - Jam: 音乐 + - Python Classroom: 教育 + - Scientific: 科学 + - Security Lab: 安全 diff --git a/docs/getting-started/before-installing.md b/docs/getting-started/before-installing.md new file mode 100644 index 0000000..79c41ca --- /dev/null +++ b/docs/getting-started/before-installing.md @@ -0,0 +1,34 @@ +# 安装前准备 + +## 准备工具 + +在开始之前,您需要准备好一个空U盘(建议8GB以上),并且关闭电脑的安全启动功能。 + +## 选择发行版 + +下面是一些由我们排序的发行版,您可以点开各自的链接 (WIP) 来了解并比较。 + +(越靠左越前沿,越靠上越困难) + +|困难&前沿 | 困难&保守 +| --- | --- | +| NixOS, Arch Linux| Gentoo | + +|简单&前沿 | 简单&适中 | 简单&保守 +| --- | --- | --- +| [Fedora](../distros/rhel/fedora.md) | Ubuntu/Kubuntu, Linux Mint, Deepin/UOS | RHEL/Rocky Linux + +或者,你也可以试试我们制作的[趣味测试](https://lati-fun.pages.dev/)。 (部署于Cloudflare Pages,访问可能缓慢) + +## 调配分区 + +我们建议您通过专业的分区工具(如[DiskGenius])进行分区。您需要用分区工具在电脑硬盘上腾出40GB(建议值)的**空闲**空间。我们不建议直接创建分区,而是在安装时由安装程序进行创建。 + +**请不要将Linux安装到任何NTFS文件系统的分区!Linux对NTFS的支持尚不完善!!!** + +**任何分区操作都存在风险,请您在操作之前确保已经备份了重要数据!!!** + +## 烧录镜像 + +在下载对应镜像后,你 + diff --git a/docs/getting-started/purpose.md b/docs/getting-started/purpose.md index 24a35a8..07ff5c7 100644 --- a/docs/getting-started/purpose.md +++ b/docs/getting-started/purpose.md @@ -41,11 +41,27 @@ 欢迎来到自由世界!Linux自创立之初就是自由软件(准确来说是创立之后不久),并且极大地推动了世界自由软件的发展,是兼顾“支持”与“自由”的选择。 +我们的教程在编写的时候也会给各个发行版以及相应的软件包标上是否自由的标签,您可以放心阅读。 +点击下一章,开始你的自由旅程吧。 ### 4. 我喜欢Linux酷炫的视觉效果 +我们很理解,作为一名小白,在看到网上那些炫酷的桌面的时候,你内心是怎样的震撼。什么具有科技感的状态栏,炫酷的图标,都比Windows要炫酷不少。 +不过,如果单纯是因为视觉效果而入坑,您一定要做好以下的心理准备: + +1. 可能与终端打交道 +2. 你的配置效果很有可能不尽人意 +3. 我们的教程并不全面,只是为入坑而写 + +并且,您一定要明辨下面的几个概念: + + - 桌面环境 (DDE) + - 发行版 + - 滚动更新 + +好啦,既然你已经准备好了,那我们就向下继续吧! ### 5. 我就是想装逼 diff --git a/docs/index.md b/docs/index.md index 5b2f1a9..313f4e0 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,9 +1,9 @@ -# LinuxCabin +# LinuxCabin Handbook -嘿!你好👋这是LinuxCabin,一个专为中国用户设计的Linux入门指南! +嘿!你好👋这是LinuxCabin Handbook,一个专为中国用户设计的Linux入门指南! **本项目目前处于未完成状态,欢迎贡献!** ## 想要入门?看这里! -[让我们开始吧!](/getting-started/purpose) +[让我们开始吧!](getting-started/purpose.md) diff --git a/images/LC.png b/images/LC.png Binary files differnew file mode 100644 index 0000000..ecfa1c7 --- /dev/null +++ b/images/LC.png @@ -1,9 +1,32 @@ site_name: LinuxCabin +site_description: A Linux handbook especially designed for Chinese users. +repo_name: LinuxCabin/linux-handbook +repo_url: https://github.com/LinuxCabin/linux-handbook theme: name: material + language: zh + features: + - search.suggest + - search.highlight + - navigation.footer + + +plugins: + - search + + +copyright: | + Licensed under <a href="https://creativecommons.org/licenses/by-nc-nd/4.0/">Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International</a><img src="https://mirrors.creativecommons.org/presskit/icons/cc.svg" alt="" style="max-width: 1em;max-height:1em;margin-left: .2em;"><img src="https://mirrors.creativecommons.org/presskit/icons/by.svg" alt="" style="max-width: 1em;max-height:1em;margin-left: .2em;"><img src="https://mirrors.creativecommons.org/presskit/icons/nc.svg" alt="" style="max-width: 1em;max-height:1em;margin-left: .2em;"><img src="https://mirrors.creativecommons.org/presskit/icons/nd.svg" alt="" style="max-width: 1em;max-height:1em;margin-left: .2em;"> nav: - index.md - 开始: - getting-started/purpose.md + - getting-started/before-installing.md + + - 发行版: + - Debian系: + - distros/debian/ubuntu.md + - 红帽系: + - distros/rhel/fedora.md - 关于: about.md diff --git a/templates/concept.md b/templates/concept.md new file mode 100644 index 0000000..d669f1f --- /dev/null +++ b/templates/concept.md @@ -0,0 +1,18 @@ +# 概念名称 + +英文:The name of the concept + +## 解释 + +这是对概念的阐释,您可以自由发挥。阐释应尽量详尽,易懂,并且我们建议您举个例子。 + +## 实践 + +在介绍诸如包管理器/常用命令一类的概念时,请您在这里列举出较为常见的指令。 + +在此以dnf作为例子。 + +1. `sudo dnf install xxx` 安装某个软件包 +2. `sudo dnf remove xxx` 卸载某个软件包 +3. `sudo dnf update` 更新所以软件包 +4. ...
\ No newline at end of file diff --git a/templates/distro.md b/templates/distro.md new file mode 100644 index 0000000..18e60b7 --- /dev/null +++ b/templates/distro.md @@ -0,0 +1,33 @@ +# 发行版名称 + + + +## 简介 + +这是一段发行版的简介,你可以写它的优点、特质,当然也可以写它的不足,请尽情发挥!但注意不要写得太长哦。 + +## 详细信息 + + - 派系:Debian/红帽/Arch/其他系 + - 发行者:Owner + - 官网:https://example.com + - 支持的系统架构:x86_64/arm64/... + - 自由软件:是/否 + - 镜像下载地址: + - > 我们建议您只需要填写以下三个主要镜像站,若某个镜像站不存在该镜像,请您直接写“无”而不应直接删除。在发布前请删除这行注释。 + - - TUNA: + - - USTC: + - - CERNET: + - 包管理器:apt/dnf/pacman/... + - 更新方式:传统/滚动/Nix/OSTree/AB分区/... + - 换源教程: + - > 我们建议您只需要填写以下三个主要镜像站,若某个镜像站不存在该镜像,请您直接写“无”而不应直接删除。在发布前请删除这行注释。 + - - TUNA: + - - USTC: + - - CERNET: + +## 风味 + +### A Editions + - Desktop: 简介 + - ...
\ No newline at end of file |
