skills.rest
KrystianYCSilva
KrystianYCSilvaCOMMUNITY
Explore all skills by this author →
GitHub

markdown-fundamentals

Create consistent Markdown documentation with CommonMark and GFM extensions.

Updated Aug 23, 2026
Search Tags:#documentation#markdown#mermaid#tables#headings#gfm#commonmark
One-click install
npx skills add https://github.com/KrystianYCSilva/hefesto-skill-generator --skill markdown-fundamentals
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: markdown-fundamentals
Source: https://github.com/KrystianYCSilva/hefesto-skill-generator/tree/main/.qwen/skills/markdown-fundamentals
Command: npx skills add https://github.com/KrystianYCSilva/hefesto-skill-generator --skill markdown-fundamentals

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This skill provides a practical guide to creating and maintaining high-quality Markdown documents that render consistently across platforms.

Core Features & Use Cases

  • CommonMark fundamentals: clear syntax for headings, emphasis, lists, code blocks, and links.
  • GFM extensions: tables, Mermaid diagrams, footnotes, and details/summary for interactive docs.
  • Cross-platform compatibility: ensures docs render correctly on GitHub, GitLab, MkDocs, Docusaurus, and other doc sites.
  • Use Case: Write README files, project docs, API docs, and user guides with reliable structure.

Quick Start

Start by creating a Markdown file with a front matter block (if your platform supports it) and a basic H1 title, then add sections with clear headings and include at least one code block and one table.

Frequently Asked Questions about markdown-fundamentals

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

FAQPage Schema
How do I write Markdown documentation that renders correctly on GitHub, GitLab, and docs sites?▼

To write cross-platform Markdown, use CommonMark basics for syntax and GFM extensions like tables and Mermaid diagrams. This ensures documentation renders consistently across GitHub, GitLab, MkDocs, and Docusaurus.

What is the best way to format Markdown tables and Mermaid diagrams for API docs?▼

The best way to format API docs is using GFM extensions for valid tables and well-formed Mermaid code blocks. This creates interactive, structured documentation that renders reliably across platforms.

Do I need front matter in my Markdown files for documentation?▼

Front matter is needed in Markdown files if your platform supports it. Enforcing front matter usage provides metadata for documentation sites, ensuring proper structure and rendering on platforms like MkDocs and Docusaurus.

How do I add accessible headings and code blocks in GitHub Flavored Markdown?▼

To add accessible headings and code blocks in GitHub Flavored Markdown, follow CommonMark fundamentals for clear syntax. Use well-formed code blocks and structured H1 titles to maintain accessible, readable documentation.

Can I use Markdown footnotes and details summary blocks for user guides?▼

You can use Markdown footnotes and details summary blocks for user guides through GFM extensions. These features allow you to create interactive documentation with collapsible sections and additional context.

Why does my Markdown table break when rendered on GitLab or Docusaurus?▼

Your Markdown table breaks due to invalid formatting or lack of CommonMark compliance. Enforcing valid table syntax and cross-platform compatibility practices ensures GFM tables render correctly on GitLab, Docusaurus, and other sites.

Related Skills

Explore More Content & Communication Skills→
nesnilnehcnesnilnehc
7

capture-work-items

Convert free-form input into backlog Markdown with front-matter and fixed statuses.

Community
Intermediate
copilot-ldcopilot-ld
1

libdoc

Render Markdown documentation into static HTML sites with Mustache templates.

Official
Advanced
PelekePeleke

llms-txt-generator

Generate llms.txt and llms-full.txt files from MkDocs navigation and markdown content.

Community
Intermediate
seb1nseb1n
147

technical-writing

Generate technical documentation in Markdown, reStructuredText, and AsciiDoc formats.

Community
Intermediate