skills.rest
mjun0812
mjun0812COMMUNITY
Explore all skills by this author β†’
Website𝕏@mjun0812GitHub

exmd

Generates single-file GFM explainer documents with glossary, TOC, and Mermaid diagrams from a fixed template.

1|Updated Aug 24, 2026
Search Tags:#template#documentation#markdown#mermaid#validation#gfm#explainer
One-click install
npx skills add https://github.com/mjun0812/skills --skill exmd-mjun0812
Or copy as Structured Prompt for Agentβ–Ό
Please help me install this Agent Skill.
Skill: exmd
Source: https://github.com/mjun0812/skills/tree/main/skills/docs/exmd
Command: npx skills add https://github.com/mjun0812/skills --skill exmd-mjun0812

SYSTEM DOCUMENTATION & REQUIREMENTS

πŸ’‘ This Skill includes scripts (resource) and assets (resource) components.

What problem does it solve? Turning concepts, mechanisms, or research findings into a readable, self-contained Markdown explainer is tedious: you need consistent structure, a glossary, a working table of contents with correct GitHub anchors, and diagrams that render on GitHub. This Skill produces one polished GFM document from a fixed template and validates it mechanically before delivery. ## Core Features & Use Cases - Template-driven generation: Fills a fixed template (frontmatter, summary, TOC, glossary, body) so every explainer has the same structure, and updates existing exmd files by rewriting only the body and the updated date. - GFM and Mermaid rules: Enforces GitHub-flavored Markdown only (no raw HTML, images, emoji, or arrow characters) and Mermaid diagrams without colors or rounded nodes so they render in both light and dark themes. - Automated validation: Ships a Python checker that verifies frontmatter fields, heading hierarchy, TOC-to-heading anchor matching, glossary table shape, and Mermaid syntax rules, and the document is not delivered until it passes. - Use Case: Ask for an explanation of a technical concept you just discussed or researched; the Skill writes a dated Markdown file with summary, glossary, TOC, and Mermaid diagrams that you can paste directly into GitHub, VS Code, or Obsidian. ## Quick Start Explain how OAuth 2.0 authorization code flow works as a single Markdown document with a glossary and Mermaid sequence diagram.

Frequently Asked Questions about exmd

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create a Markdown explainer document with a glossary and table of contents?β–Ό

Ask for the topic to be explained in Markdown; the Skill copies its template, fills placeholders for title, dates, summary, TOC, glossary, and body, then saves a dated Markdown file. A validation script must pass before the file is reported as done.

How do I write Mermaid diagrams that render correctly on GitHub?β–Ό

Use mermaid code fences with flowchart TD, sequenceDiagram, erDiagram, or stateDiagram-v2 depending on content. Use only rectangular id[label] nodes, avoid HTML tags and color or style directives, since GitHub renders diagrams in the reader's theme.

Does the generated Markdown work in Obsidian and VS Code?β–Ό

Yes, the output is plain GitHub-flavored Markdown with no raw HTML, images, or custom syntax, so it renders in GitHub, VS Code, and Obsidian without modification. Math uses inline $...$ and display $$ blocks.

How do I update an existing exmd document instead of creating a new one?β–Ό

If the file contains the exmd template marker, the Skill rewrites only the body, glossary, TOC, and the updated frontmatter field while keeping the original filename. The fixed template sections and frontmatter fields are not changed.

Why does the exmd validation script report errors on my document?β–Ό

The checker fails on missing frontmatter fields, leftover placeholders, multiple h1 headings, skipped heading levels, TOC links that do not match GitHub heading anchors, emoji or HTML in prose, code fences without a language, and Mermaid blocks with colors or rounded nodes.

When should I not use this Markdown explainer format?β–Ό

Do not use it for transcribing content already established in conversation verbatim, which is the chat-note use case, or for HTML-based explanations, which belong to exhtml. It targets standalone GFM explainer documents only.

Related Skills

Explore More Content & Communication Skills→
pascallammerspascallammers
1

content-research-writer

Research topics and write articles, documentation, and technical content with citations.

Community
Intermediate
Globaly-IncGlobaly-Inc

gh-repo-docs

Generate Markdown reference documentation from GitHub repository metadata and file structures.

Official
Advanced
masakinihirotamasakinihirota

writing-style

Enforces consistent Japanese writing style rules for technical documentation and articles.

Community
Basic
danseelydanseely

md

Convert Markdown documents into GitHub-styled HTML via the GitHub Markdown API.

Community
Intermediate