菜单
Internal support capability for rendering checked-in Markdown into durable preview artifacts so doc-facing workflows can review real terminal output instead of raw source alone.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
| name | markdown-preview |
| description | Internal support capability for rendering checked-in Markdown into durable preview artifacts so doc-facing workflows can review real terminal output instead of raw source alone. |
This is a support capability, not a public workflow concept.
Use it when a doc-facing workflow needs rendered terminal snapshots for README, docs, or spec prose review.
This is not a rule that every Markdown review must use glow. When the target
is an executable *.spec.md whose authoritative reader surface is a Specdown
report, review the rendered Specdown report instead of treating a raw Markdown
preview as equivalent.
glow for terminal-faithful Markdown rendering when it is available<repo-root>/.agents/markdown-preview.yaml,
<repo-root>/.codex/markdown-preview.yaml, <repo-root>/.claude/markdown-preview.yaml,
<repo-root>/docs/markdown-preview.yaml, and <repo-root>/markdown-preview.yamlglow is missing, write degraded artifacts that say so explicitly
instead of pretending source-only review is equivalentrendered, degraded, and backend-error; an installed backend
that fails or renders blank output for non-empty Markdown is backend-error,
not an acceptable raw-source fallbackglow by rendering a tiny Markdown sample and confirming non-empty
output, not only by checking that the binary existsUse the helper. Resolve $SKILL_DIR per ../../shared/references/bootstrap-resolution.md, then run:
python3 "$SKILL_DIR/scripts/render_markdown_preview.py" --repo-root . --file README.md --width 80 --width 100
python3 "$SKILL_DIR/scripts/render_markdown_preview.py" --repo-root . --changed-only
python3 "$SKILL_DIR/scripts/render_markdown_preview.py" --repo-root . --config .agents/markdown-preview.yaml
python3 "$SKILL_DIR/scripts/check_glow_backend.py"
references/runtime-contract.mdscripts/render_markdown_preview.pyUse when a maintainer needs to cut, bump, or verify a repo release surface such as plugin versions, generated install manifests, and operator update instructions.
Use when a non-trivial design decision, code change, release, rename, deletion, spec, or workflow change needs a before-the-fact critique. Probe distinct failure angles, then run a counterweight pass that separates real blockers from over-worry before the change locks in.
Use after a meaningful work unit or when the user asks for a retrospective. Reviews what happened, what created waste, which decisions mattered, which named expert lens or direct counterfactual would have changed the next move, and which workflow/capability/memory improvements should make the next session better. Auto-selects `session` or `weekly` mode from context; ambiguous cases default to `session`.
Use when the goal is to understand and improve the repo's current quality bar. Detect existing gates, run the available ones, inspect concept integrity, test confidence, and security posture, then propose concrete quality moves instead of only complaining about what is missing.
Use when filing a GitHub issue from current context or resolving GitHub issues end-to-end through the adapter-resolved backend (`gh` by default, or a host-mediated capability such as `acme github`). Issue creation reports the observed problem before suggesting solutions; issue resolution treats GitHub as the source of truth, classifies the issue, runs a causal review for bug-class issues before designing the fix, and runs a resolution critique so the same class of issue does not recur.
Use when a repo needs its initial operating surface created or normalized. Bootstrap README, AGENTS.md, CLAUDE.md symlink policy, roadmap, and operator-acceptance docs from minimal ideation for greenfield repos, or realign those same surfaces for partially-initialized repos without pretending quality review or deep product ideation already happened.