Markdown Glossary
Technical terms explained for developers working with markdown.
AI-Generated Documentation
AI-generated documentation refers to technical writing created with AI assistants like Claude, ChatGPT, or GitHub Copilot. Common use cases: - Code e...
Code Fence
A code fence is a markdown syntax for creating code blocks using triple backticks (```). Code fences can include a language identifier for syntax hig...
Documentation as Code
Documentation as Code (Docs-as-Code) is an approach where documentation is treated like source code: - Stored in version control (Git) - Written in p...
Frontmatter
Frontmatter is metadata placed at the beginning of a markdown file, typically in YAML format, enclosed by triple dashes (---). Common frontmatter fie...
GitHub Flavored Markdown (GFM)
GitHub Flavored Markdown (GFM) is a variant of Markdown created by GitHub. It adds several features beyond standard Markdown: - Task lists with check...
Markdown
Markdown is a lightweight markup language created by John Gruber in 2004. It uses plain text formatting syntax that can be converted to HTML and other...
Markdown Renderer
A markdown renderer is software that converts markdown text to HTML or another format for display. Rendering process: 1. Parse markdown text into AST...
MDX
MDX is a format that lets you use JSX (React components) within markdown documents. MDX is popular in documentation sites and blogs built with React ...
Mermaid Diagrams
Mermaid is a JavaScript-based diagramming and charting tool that uses text-based definitions to create diagrams dynamically. Supported diagram types:...
README File
A README file (typically README.md) is a markdown document that introduces and explains a project. It's usually the first file users see when visiting...
Shiki
Shiki is a syntax highlighter powered by TextMate grammars - the same grammars used by VS Code. It provides accurate, beautiful syntax highlighting fo...
Static Site Generator (SSG)
A Static Site Generator (SSG) is a tool that generates HTML pages from templates and content files (often markdown) at build time. Popular SSGs: - Ne...
Syntax Highlighting
Syntax highlighting is the display of source code in different colors and fonts according to the category of terms. This makes code easier to read and...
Table of Contents (TOC)
A Table of Contents (TOC) in markdown is a navigation list of headings in a document. markshare automatically generates a TOC from your headings - no...
Terminal Workflow
A terminal workflow refers to development practices centered around command-line interfaces (CLI) rather than graphical tools. Developers with termin...