Skip to content

Commit 104ac01

Browse files
committed
docs: move repo positioning sections from README to MkDocs鍗氬鏂规.md
1 parent 20c99b1 commit 104ac01

2 files changed

Lines changed: 87 additions & 86 deletions

File tree

README.md

Lines changed: 0 additions & 86 deletions
Original file line numberDiff line numberDiff line change
@@ -276,89 +276,3 @@
276276
### 项目记录与随笔
277277

278278
详见 [ANote 栏目](docs/ANote/index.md)
279-
280-
281-
## 🏗️ 仓库定位
282-
283-
这个仓库承担两层职责:
284-
285-
### 1. 基础版博客
286-
287-
直接通过 GitHub 仓库阅读内容:
288-
289-
- 浏览 `docs/` 目录查看文章原文
290-
- 通过各分类 `index.md` 查看栏目导览
291-
- 查看提交记录、差异、历史版本
292-
293-
### 2. 高级版博客
294-
295-
通过 GitHub Pages 提供更适合阅读的站点体验:
296-
297-
- 更完整的导航结构
298-
- 标签索引
299-
- 搜索与主题样式
300-
- 后续可继续接入评论、自定义域名等能力
301-
302-
---
303-
304-
## 📋 内容组织规则
305-
306-
- 分类以文件夹为主,例如 `docs/u3d/``docs/shader/`
307-
- 每个分类目录下都有一个 `index.md` 作为栏目页
308-
- 文章使用 front matter 维护 `title``date``tags``categories`
309-
- `categories` 作为元数据补充,通常与所在目录保持一致
310-
- `tags` 用于更细粒度的主题聚合
311-
312-
---
313-
314-
## ✍️ 新增文章的基本流程
315-
316-
1. 选择所属分类目录,例如 `docs/u3d/`
317-
2. 新建文章 Markdown 文件
318-
3. 写入 front matter
319-
4. 完成正文内容
320-
5. 更新对应分类下的 `index.md`
321-
6. 如有必要,再更新 `docs/tags/index.md`
322-
7. 提交并推送,等待站点自动部署
323-
324-
---
325-
326-
## 📝 文章模板
327-
328-
```markdown
329-
---
330-
title: "文章标题"
331-
date: "2026-03-22"
332-
tags:
333-
- 标签1
334-
- 标签2
335-
categories:
336-
- u3d
337-
comments: true
338-
---
339-
340-
# 文章标题
341-
342-
正文内容。
343-
```
344-
345-
---
346-
347-
## 🚀 本地预览
348-
349-
安装依赖后可以本地预览:
350-
351-
```bash
352-
pip install mkdocs-material mkdocs-git-revision-date-localized-plugin mkdocs-git-authors-plugin gitpython jieba
353-
mkdocs serve
354-
```
355-
356-
默认访问:`http://127.0.0.1:8000/`
357-
358-
---
359-
360-
## 🌐 部署方式
361-
362-
仓库推送后通过 GitHub Pages 自动部署高级版站点。
363-
364-
如果后续接入自定义域名、评论系统或进一步调整首页/栏目页,也都以这个仓库为统一内容源。

docs/MkDocs博客方案.md

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -796,3 +796,90 @@ edit_uri: edit/master/docs/
796796
- 忽略:`master` 分支忽略 `site/`
797797

798798
这套方案最适合当前仓库的结构,也最容易长期维护。
799+
800+
---
801+
802+
## 🏗️ 仓库定位
803+
804+
这个仓库承担两层职责:
805+
806+
### 1. 基础版博客
807+
808+
直接通过 GitHub 仓库阅读内容:
809+
810+
- 浏览 `docs/` 目录查看文章原文
811+
- 通过各分类 `index.md` 查看栏目导览
812+
- 查看提交记录、差异、历史版本
813+
814+
### 2. 高级版博客
815+
816+
通过 GitHub Pages 提供更适合阅读的站点体验:
817+
818+
- 更完整的导航结构
819+
- 标签索引
820+
- 搜索与主题样式
821+
- 后续可继续接入评论、自定义域名等能力
822+
823+
---
824+
825+
## 📋 内容组织规则
826+
827+
- 分类以文件夹为主,例如 `docs/u3d/`、`docs/shader/`
828+
- 每个分类目录下都有一个 `index.md` 作为栏目页
829+
- 文章使用 front matter 维护 `title`、`date`、`tags`、`categories`
830+
- `categories` 作为元数据补充,通常与所在目录保持一致
831+
- `tags` 用于更细粒度的主题聚合
832+
833+
---
834+
835+
## ✍️ 新增文章的基本流程
836+
837+
1. 选择所属分类目录,例如 `docs/u3d/`
838+
2. 新建文章 Markdown 文件
839+
3. 写入 front matter
840+
4. 完成正文内容
841+
5. 更新对应分类下的 `index.md`
842+
6. 如有必要,再更新 `docs/tags/index.md`
843+
7. 提交并推送,等待站点自动部署
844+
845+
---
846+
847+
## 📝 文章模板
848+
849+
```markdown
850+
---
851+
title: "文章标题"
852+
date: "2026-03-22"
853+
tags:
854+
- 标签1
855+
- 标签2
856+
categories:
857+
- u3d
858+
comments: true
859+
---
860+
861+
# 文章标题
862+
863+
正文内容。
864+
```
865+
866+
---
867+
868+
## 🚀 本地预览
869+
870+
安装依赖后可以本地预览:
871+
872+
```bash
873+
pip install mkdocs-material mkdocs-git-revision-date-localized-plugin mkdocs-git-authors-plugin gitpython jieba
874+
mkdocs serve
875+
```
876+
877+
默认访问:`http://127.0.0.1:8000/`
878+
879+
---
880+
881+
## 🌐 部署方式
882+
883+
仓库推送后通过 GitHub Pages 自动部署高级版站点。
884+
885+
如果后续接入自定义域名、评论系统或进一步调整首页/栏目页,也都以这个仓库为统一内容源。

0 commit comments

Comments
 (0)