Markdown docs hygiene
暂无简介
- License 许可
- MIT
- 所属仓库
- rhCat/skillChip
- 最近更新
- 2026-07-31
- Stars
- ★ 0
- Forks
- 0
01 前言 Front Matter
- name
- Markdown docs hygiene
- perks
- [ "toc", "links" ]
- skill
- markdown
02 资源文件 21
- 其他blueprint.drawio2.7 KB
- 参考文档blueprint.json3.7 KB
- 资产文件blueprint.svg8.9 KB
- 参考文档index.json2.2 KB
- 参考文档ledger.json280 B
- 参考文档perks.json419 B
- 参考文档perks/links/manifesto.json304 B
- 参考文档perks/links/metadata.json583 B
- 参考文档perks/links/src/contracts.json323 B
- 脚本perks/links/src/md_links.py2.5 KB
- 脚本perks/links/src/md_links.sh346 B
- 参考文档perks/links/test/case.json224 B
- 参考文档perks/links/test/fixture/doc.md45 B
- 参考文档perks/links/test/fixture/target.md54 B
- 参考文档perks/toc/manifesto.json298 B
- 参考文档perks/toc/metadata.json578 B
- 参考文档perks/toc/src/contracts.json298 B
- 脚本perks/toc/src/md_toc.py2.5 KB
- 脚本perks/toc/src/md_toc.sh340 B
- 参考文档perks/toc/test/case.json152 B
- 参考文档perks/toc/test/fixture/doc.md52 B
03 SKILL.md 正文
markdown — Markdown docs hygiene
Generate a table of contents or find dead relative links in a Markdown file — read-only.
Both perks read a single .md file and never modify it; they only write a report under
record_store.
What to look out for
Each tool emits one line of structured JSON (the audit + debug log) and writes its
artifacts under record_store. LOGS TO CHECK: that line + the named report + the executor run-ledger.
Perks
| perk | tool | nature |
|---|---|---|
toc |
md_toc |
read-only / safe |
links |
md_links |
read-only / safe |
The toc perk scans ATX headings (#…######), skips headings inside fenced code blocks, and
writes a nested bullet list of - [text](#slug) links (GitHub-style slugs) to toc.md — always,
even when the file has no headings.
The links perk extracts inline [text](target) links, keeps only RELATIVE targets (skipping
http://, https://, mailto:, and pure #anchor links), strips any #fragment, resolves each
against the Markdown file's directory, and reports the ones that do not exist to link_report.json.
How to use it
Pick a perk, copy ledger.json → task-ledger.json, fill its vars + record_store, then
validate → compose → compile → oversight → executor.
04 同仓库更多 Skills
Vercel Deploy
暂无简介
Audio Transcribe
暂无简介
Speech (OpenAI TTS)
暂无简介
Skill Installer
暂无简介
demo-skill
A demo skill used as a test fixture for the validate perk. Use when checking that quick_validate.py accepts a well-formed SKILL.md.
demo-skill
A demo skill used as a test fixture for generating agents/openai.yaml. Use when validating the gen_openai_yaml perk.