使用 Material for MkDocs 构建的 Markdown 网站。
从小红书图文过来的读者,可以直接打开下面的资料:
- 完整教程:GPT-6 Astra 升级后,怎样整理 AGENTS.md 与 Skills
- 可复制提示词:单项目完整试用版、全量正式修改版、完整基础版
- 下载全部提示词与教程 ZIP
- 打开排版后的提示词页面
完整基础提示词为 6,829 字符。单项目版和全量版保留全部要求,只在开头补充本次运行参数,默认不启动子 Agent。教程中的项目范围与 Skills 采用匿名说明。
教程按主题文件夹组织:
docs/tutorials/
├── index.md
└── obsidian/
├── index.md
├── .pages
└── *.md
以后可以在 docs/tutorials/ 下增加与 obsidian/ 并列的新分类。每个分类建议包含:
index.md:分类介绍页。.pages:分类名称与页面顺序。- 教程 Markdown:每篇教程一个文件。
- 复制
templates/tutorial.md。 - 把新文件上传到对应分类,例如
docs/tutorials/obsidian/。 - 在文件开头填写
title、description和tags:
---
title: 教程标题
description: 一句话介绍
tags:
- Obsidian
- 视频学习
---- 把改动提交到 GitHub 的
main分支。
提交后,GitHub Actions 会自动:
- 扫描所有分类文件夹中的 Markdown。
- 更新左侧 Tag 筛选索引。
- 把 Markdown 构建成 HTML。
- 发布到
gh-pages分支。
只上传 Markdown 即可更新教程,但必须满足三个条件:文件位于 docs/tutorials/<分类>/、提交到 main 分支、仓库已经启用 GitHub Pages 和 Actions。
docs/tutorials/.pages控制分类顺序。- 分类内的
.pages控制教程顺序。 .pages中的...会自动收录没有显式列出的新文件,并放在已固定页面之后。- 如果要精确调整一篇新教程的位置,把它的文件名加入对应分类的
.pages即可。
Markdown 中可以直接插入 HTML。推荐复制模板里的播放器区块,只替换两处 BV 号:
<div class="video-embed">
<iframe src="https://player.bilibili.com/player.html?bvid=BV号&page=1&high_quality=1&danmaku=0&autoplay=0" title="B 站课程视频" loading="lazy" allowfullscreen></iframe>
</div>
<p class="video-link"><a href="https://www.bilibili.com/video/BV号/" target="_blank" rel="noopener">在 B 站打开 →</a></p>autoplay=0 明确关闭自动播放;iframe 也没有申请 autoplay 权限。用户需要主动点击后才会播放。
本地首次预览:
python3 -m venv .venv
.venv/bin/python -m pip install -r requirements.txt
.venv/bin/python scripts/generate_tag_index.py
.venv/bin/mkdocs serve推送到 GitHub 的 main 分支后,工作流会自动构建并发布到 gh-pages 分支。