更新文档

plos-clan · Sep 4, 2024 · 31e989b · 31e989b
1 parent 3f28548
commit 31e989b
Show file tree

Hide file tree

Showing 23 changed files with 109 additions and 49 deletions.
diff --git a/docs/.pages b/docs/.pages
@@ -0,0 +1,7 @@
+nav:
+  - 主页: index.md
+  - 项目状态: projects.md
+  - 计划: todo.md
+  - 库: libraries
+  - Plant-OS: Plant-OS
+  - CoolPotOS: CoolPotOS
diff --git a/docs/404.md b/docs/404.md
diff --git a/docs/404/assets/114514.png b/docs/404/assets/114514.png
diff --git a/docs/404/assets/icon-1.png b/docs/404/assets/icon-1.png
diff --git a/docs/404/assets/icon-2.png b/docs/404/assets/icon-2.png
diff --git a/docs/404/assets/icon-3.png b/docs/404/assets/icon-3.png
diff --git a/docs/404/assets/icon-4.png b/docs/404/assets/icon-4.png
diff --git a/docs/404/assets/icon-5.png b/docs/404/assets/icon-5.png
diff --git a/docs/404/assets/icon-6.png b/docs/404/assets/icon-6.png
diff --git a/docs/404/assets/icon-7.png b/docs/404/assets/icon-7.png
diff --git a/docs/404/assets/icon-8.png b/docs/404/assets/icon-8.png
diff --git a/docs/404/assets/icon-9.png b/docs/404/assets/icon-9.png
diff --git a/docs/404/index.md b/docs/404/index.md
@@ -0,0 +1,24 @@
+---
+search:
+  exclude: true
+---
+
+# 隐藏页面
+
+## 114514
+
+![114:51:40](assets/114514.png)
+
+## 已过时的
+
+### Plant-OS 吉祥物备选项
+
+![icon 1](assets/icon-1.png)
+![icon 2](assets/icon-2.png)
+![icon 3](assets/icon-3.png)
+![icon 4](assets/icon-4.png)
+![icon 5](assets/icon-5.png)
+![icon 6](assets/icon-6.png)
+![icon 7](assets/icon-7.png)
+![icon 8](assets/icon-8.png)
+![icon 9](assets/icon-9.png)
diff --git a/docs/CoolPotOS/index.md b/docs/CoolPotOS/index.md
@@ -5,4 +5,4 @@ meta:
     content: 关于 CoolPotOS
 ---
 
-# 关于 CoolPotOS
+# 关于 CoolPotOS<span style="margin: 0 10px;"></span>[[github]](https://github.com/plos-clan/CoolPotOS)
diff --git a/docs/Plant-OS/index.md b/docs/Plant-OS/index.md
@@ -5,7 +5,7 @@ meta:
     content: 关于 Plant-OS
 ---
 
-# 关于 Plant-OS
+# 关于 Plant-OS<span style="margin: 0 10px;"></span>[[github]](https://github.com/plos-clan/Plant-OS)
 
 ![Static Badge](https://img.shields.io/badge/License-MIT-blue)<span style="margin: 0 10px;"></span>
 ![Static Badge](https://img.shields.io/badge/Language-3-orange)<span style="margin: 0 10px;"></span>

diff --git a/docs/libraries/libc++/index.md → docs/libraries/libc++.md b/docs/libraries/libc++/index.md → docs/libraries/libc++.md
diff --git a/docs/libraries/libc-base/alloc.md b/docs/libraries/libc-base/alloc.md
@@ -7,4 +7,4 @@ meta:
 
 # 内存分配器
 
-![](/assets/内存管理.svg)
+![内存管理](assets/内存管理.svg)
diff --git a/docs/assets/内存管理.svg → docs/libraries/libc-base/assets/内存管理.svg b/docs/assets/内存管理.svg → docs/libraries/libc-base/assets/内存管理.svg
diff --git a/docs/libraries/libc/index.md → docs/libraries/libc.md b/docs/libraries/libc/index.md → docs/libraries/libc.md
diff --git a/docs/libraries/misc.md b/docs/libraries/misc.md
@@ -0,0 +1,72 @@
+---
+comments: true
+meta:
+  - property: og:title
+    content: libmisc
+title: misc
+---
+
+# plos misc
+
+各种可能会使用到的函数
+
+## crypto
+
+用于加密、解密、编码与哈希的函数集
+
+### 加密、解密
+
+- `caesar`
+
+### 编码
+
+- `base64`
+- `hex`
+
+### 哈希
+
+- `crc16`
+- `crc32`
+- `md2`
+- `md5`
+- `sha256`
+
+| Benchmark | Time        | CPU         | Iterations |
+|-----------|-------------|-------------|------------|
+| HASH      | 965213 ns   | 965165 ns   | 718        |
+| CRC16     | 2159411 ns  | 2159417 ns  | 322        |
+| CRC32     | 1919038 ns  | 1918664 ns  | 365        |
+| MD2       | 80181603 ns | 80179200 ns | 9          |
+| MD5       | 5365364 ns  | 5365305 ns  | 130        |
+| SHA256    | 9748719 ns  | 9748511 ns  | 72         |
+
+> 测试数据大小 1,000,000
+
+## math
+
+扩展的数学函数集
+
+- `FFT`
+- `MDCT`
+- ...
+
+| Benchmark | Time     | CPU      | Iterations |
+|-----------|----------|----------|------------|
+| PLOS_FFT  | 24344 ns | 24343 ns | 28176      |
+| FFTW      | 4071 ns  | 4071 ns  | 171647     |
+
+> 测试数据大小 2048
+
+**测试平台**
+
+```plan
+CPU: AMD Ryzen 7 5800H with Radeon Graphics
+Run on (16 X 4463 MHz CPU s)
+CPU Caches:
+  L1 Data 32 KiB (x8)
+  L1 Instruction 32 KiB (x8)
+  L2 Unified 512 KiB (x8)
+  L3 Unified 16384 KiB (x1)
+```
+
+具体测试代码见 [Plant-OS](/Plant-OS/) 储存库
diff --git a/docs/libraries/misc/index.md b/docs/libraries/misc/index.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -35,10 +35,11 @@ extra:
 
 plugins:
   - search
+  - awesome-pages
   - markdownextradata
   - exclude:
       glob:
-        - 404.md
+        - README.md
 
 markdown_extensions:
   - abbr

diff --git a/requirements.txt b/requirements.txt
@@ -3,5 +3,6 @@ mkdocs-exclude
 mkdocs-material
 mkdocs-material-extensions
 mkdocs-markdownextradata-plugin
+mkdocs-awesome-pages-plugin
 pymdown-extensions
 mdx_truly_sane_lists