使用文档模板

docs/index.md

@@ -0,0 +1 @@
+# 欢迎来到 Plant-OS 文档页

mm.md → docs/mm.md

@@ -18,7 +18,7 @@ Plant OS内存管理的实现
 
 在32位模式下，线性地址的组成分为三个部分
 
-```[graph]
+<!-- ```[graph]
 digraph G {
     "dir" [
         label = "<f0>Directory | <f1>Table | <f2>Offset"
@@ -63,7 +63,7 @@ digraph G {
     "third+" -> "页":f0
     
 }
-```
+``` -->
 
 依据此原理，我们可以维护页目录和页表来设置线性地址与物理地址的对应关系
 

docs/sub-projects.md

@@ -0,0 +1,77 @@
+# 子模块
+
+目前 PlantOS 分为以下几个部分
+
+- boot
+  - state: `Semi-abandoned`
+  - author: min0911Y & duoduo70 & ZhouZhihaos
+- loader
+  - state: `Semi-abandoned`
+  - author: min0911Y & duoduo70 & ZhouZhihaos
+- kernel
+  - state: `In progress`
+  - author: min0911Y & duoduo70 & ZhouZhihaos & copi143 (minority)
+- apps
+  - state: `TODO`
+  - author: ~~copi143 & min0911Y~~
+- libc-base
+  - state: `In progress`
+  - author: copi143
+- pl_readline
+  - state: `Final`
+  - author: min0911Y
+- data-structure
+  - state: `In progress`
+  - author: copi143 (majority) & min0911Y (minority)
+- algorithm
+  - state: `TODO`
+  - author: ~~copi143~~
+- fs
+  - state: `In progress`
+  - author: copi143 & min0911Y & XIAOYI12
+  - remark: The fatfs part comes from [abbrev/fatfs](https://github.com/abbrev/fatfs).
+  - remark: The iso9660 part comes from [xiaoyi1212/CoolPotOS/src/fs](https://github.com/xiaoyi1212/CoolPotOS/blob/main/src/fs/iso9660.c)
+- sys
+  - state: `In progress`
+  - author: copi143
+- libc
+  - state: `TODO`
+  - author: ~~copi143~~
+- libc++
+  - state: `TODO`
+  - author: ~~copi143~~
+- misc
+  - state: `In progress`
+  - author: copi143
+- font
+  - state: `Paused`
+  - author: copi143
+- plty
+  - state: `Paused`
+  - author: copi143
+- pl2d
+  - state: `Paused`
+  - author: copi143
+  - Waiting for more developers.
+- plds
+  - state: `TODO`
+  - author: ~~copi143~~
+  - Waiting for more developers.
+- plui
+  - state: `TODO`
+  - author: ~~copi143~~
+  - Waiting for more developers.
+- plac
+  - state: `Final`
+  - author: copi143
+- usersystem
+  - state: `TODO`
+  - author XIAOYI12
+
+## **state** 解释
+
+- `TODO`: 画大饼，准备做但几乎没有开始
+- `In progress`: 正在编写但仍未达到可以发布
+- `Semi-abandoned`: 很长一段时间内不会被更新
+- `Final`: 已是最终版本，除修复 bug 外不会执行其它更新
+- `Paused`: 暂停更新

mkdocs.yml

@@ -0,0 +1,51 @@
+site_name: Plant-OS 文档
+docs_dir: docs
+repo_url: https://github.com/plos-clan/Plant-OS
+site_url: https://doc.plos-clan.org
+
+copyright: Copyright © 2024 plos-clan
+
+theme:
+  favicon: assets/favicon.ico
+  logo: assets/favicon.ico
+  name: material
+  language: zh
+  features:
+    - navigation.instant
+    - navigation.instant.prefetch
+    - navigation.instant.progress
+    - navigation.sections
+    - navigation.tracking
+    - navigation.path
+    - navigation.indexes
+    - navigation.top
+    - toc.follow
+    - toc.integrate
+
+extra:
+  generator: false # 删除 Made with Material for MkDocs 文本
+
+plugins:
+  - search
+  - markdownextradata
+
+markdown_extensions:
+  - toc:
+      permalink: true
+  - tables # 支持表格
+  - fenced_code # 支持围栏代码块
+  - codehilite:
+      guess_lang: false # 代码高亮
+  - admonition # 支持附注框
+  - pymdownx.superfences # 增强的围栏代码块支持
+  - pymdownx.tasklist # 支持任务列表
+  - pymdownx.emoji # 支持表情符号
+  - pymdownx.magiclink # 自动处理链接
+  - pymdownx.tabbed # 支持选项卡布局
+  - pymdownx.betterem # 改进的强调（斜体和粗体）
+  - pymdownx.caret # 支持^上标^
+  - pymdownx.tilde # 支持~删除线~
+  - pymdownx.mark
+  - pymdownx.details
+  - mdx_truly_sane_lists
+  - footnotes