Blog
Markdown, documentation, developer tools, and the workflows that connect them.
How to Write API Documentation in Markdown
How to structure and write API documentation using markdown. Covers endpoint tables, request/response examples, authentication docs, and ready-to-use templates.
How to Write a Changelog: Format, Examples, and Templates
How to create and maintain a changelog for your project. Covers the Keep a Changelog format, semantic versioning, automation, and ready-to-use templates.
Markdown Bold and Italic: How to Format Text
How to make text bold, italic, or both in markdown. Covers asterisks vs underscores, nesting rules, and platform-specific behavior.
How to Write Markdown: A Beginner's Guide
Learn markdown from scratch. This step-by-step guide teaches you headings, formatting, links, images, lists, and code blocks with practical examples.
Markdown Blockquotes: Syntax and Creative Uses
How to create blockquotes in markdown, including nested quotes, multi-paragraph quotes, callout boxes, and GitHub-style admonitions.
Markdown Escape Characters: The Complete List
How to display literal markdown symbols using backslash escapes. Covers every escapable character with examples and common scenarios.
Markdown Emoji: Shortcodes and Unicode Characters
How to add emoji to markdown using shortcodes and Unicode. Covers GitHub emoji, platform support, and when to use emoji in documentation.
Markdown Footnotes: How to Add References and Citations
How to use footnotes in markdown for citations, references, and supplementary notes. Covers syntax, multi-paragraph footnotes, and platform support.
Markdown in Discord: Formatting Guide
How to format text in Discord using markdown syntax. Covers bold, italic, code blocks, spoilers, headers, lists, and what Discord does differently.
GitHub Markdown: The Complete GFM Guide
Everything you need to know about writing markdown on GitHub. Covers GFM syntax, README files, issues, PRs, alerts, Mermaid diagrams, and math expressions.
Markdown in Slack: What Works and What Doesn't
Slack uses its own formatting syntax called mrkdwn, not standard markdown. Learn what works, what doesn't, and how to share formatted documents in Slack.
Markdown Formatting: The Complete Guide
Everything you can do with markdown formatting in one place. Text styling, structure, code, tables, links, and more with examples and copy-paste templates.
Markdown Headings: Syntax, Levels, and Best Practices
How to use headings in markdown from H1 to H6. Covers ATX vs Setext syntax, heading IDs, anchor links, and document structure best practices.
Markdown Images: Syntax, Alt Text, and Sizing
How to add images in markdown with proper alt text, sizing, captions, and links. Covers inline images, reference-style, and platform-specific behavior.
Obsidian Markdown: Syntax Guide and Unique Features
How markdown works in Obsidian, including wikilinks, callouts, embeds, and other features not found in standard markdown. Plus tips for portable documents.
HTML in Markdown: When and How to Use Raw HTML
Which HTML tags work in markdown, when to use them, and what each platform allows. Covers details/summary, kbd, tables, and security restrictions.
Markdown in VS Code: Editing, Previewing, and Extensions
How to write, preview, and publish markdown in VS Code. Covers built-in features, keyboard shortcuts, recommended extensions, and advanced workflows.
Markdown Links: Inline, Reference, and Auto-Links
How to create links in markdown using inline syntax, reference-style links, and auto-links. Includes anchor links, email links, and platform differences.
Markdown Lists: Ordered, Unordered, and Nested
How to create bullet points, numbered lists, nested lists, and definition lists in markdown. Includes nesting rules, continuation, and platform differences.
Markdown Strikethrough: How to Cross Out Text
How to use strikethrough in markdown with double tildes. Covers syntax, use cases, platform differences, and combining with other formatting.
Markdown Task Lists: Checklists in Markdown
How to create checkboxes and task lists in markdown. Covers interactive vs static checklists, GitHub usage, project tracking, and platform differences.
Markdown vs reStructuredText: Which Should You Use?
A detailed comparison of markdown and reStructuredText for documentation. Covers syntax, ecosystem, extensibility, and when each format is the better choice.
What Is CommonMark? The Standardized Markdown Spec
CommonMark is a strict specification for markdown that resolves ambiguities in the original syntax. Learn what it standardizes, why it matters, and who uses it.
What Is Frontmatter? Metadata in Markdown Files
Frontmatter is a YAML block at the top of markdown files that stores metadata like title, date, and author. Learn the syntax, common fields, and how tools use it.
What Is GitHub Flavored Markdown (GFM)?
GitHub Flavored Markdown extends standard markdown with tables, task lists, strikethrough, auto-linking, and more. Learn what GFM adds and where it works.
What Is Markdown? A Plain-English Explanation
Markdown is a lightweight markup language that formats plain text using simple symbols. Learn what it is, where it's used, and why developers prefer it.
What Is MDX? Markdown with React Components
MDX lets you embed React (or other JSX) components directly in markdown files. Learn what MDX is, how it works, and when to use it over regular markdown.
How to Host Internal Documentation Without Building a Docs Site
You don't need Docusaurus or GitBook for every docs project. Sometimes publishing markdown files to URLs is enough.
AI Documentation Tools: How to Generate and Publish Docs with AI
AI tools can write documentation from your code. The missing step is publishing. Here's the full workflow.
Using Git for Documentation: A Markdown Workflow
How to manage documentation with Git and markdown. Branch strategies, review workflows, and CI/CD publishing.
What is MCP (Model Context Protocol)? A Developer's Guide
MCP lets AI agents interact with external tools through a standard protocol. Here's how it works and why it matters for developers.
How to Publish Markdown Online: 5 Ways Compared
Five approaches to getting your markdown files online. From static site generators to one-command publishing.
How to Share Documents Without Email Attachments
Email attachments create version drift and inbox bloat. Here are better ways to share documents with your team.
How to Write a README That People Actually Read
What to include in your README, what to skip, and how to format it so people don't bounce in 3 seconds.
Obsidian Publish Alternatives: 5 Ways to Share Your Notes
Obsidian Publish costs $8/mo per site. Here are 5 alternatives for getting your notes online, from free to low-cost.
Markdown vs HTML: When to Use Each
Markdown is for writing. HTML is for rendering. Here's when to use each format and how to convert between them.
Best Markdown Editors in 2026: VS Code, Obsidian, Typora, and More
Honest comparison of the best markdown editors. VS Code, Obsidian, Typora, iA Writer, Zettlr, and online alternatives.
What is AGENTS.md? The New Standard for AI Agent Instructions
AGENTS.md tells AI coding agents how to work with your project. Think of it as robots.txt for AI assistants.
Markdown Code Blocks and Syntax Highlighting
How to use inline code, fenced code blocks, and syntax highlighting in markdown. Language support and rendering differences.
Release Notes vs Changelog: What's the Difference?
Changelogs list every change for developers. Release notes explain what matters to users. Here's when to use each.
Markdown Tables: How to Create, Align, and Style Them
Complete guide to markdown table syntax. Alignment, formatting, multi-line cells, limitations, and workarounds.
Markdown for Technical Writers: A Practical Guide
Why technical writers should learn markdown, and how to use it for documentation, knowledge bases, and content pipelines.
Markdown Cheat Sheet: Every Syntax You Need
Quick-reference guide to markdown syntax. Headings, emphasis, links, images, code blocks, tables, task lists, and GitHub Flavored Markdown extensions.
How to Convert Markdown to PDF with Custom Styling
Make your markdown PDFs look professional. Browser print, Pandoc, Puppeteer, and CSS techniques for styled output.
How to Build a Developer Resume in Markdown
Write your resume in markdown for version control, easy updates, and multiple output formats. Includes a complete template.