Markdown guides

In-depth guides for writing Markdown across the tools you already use.

Markdown Files for AI Agents: A Complete Guide
Guide

Markdown Files for AI Agents: A Complete Guide

Compare AGENTS.md, CLAUDE.md, GEMINI.md, Cursor and Windsurf rules, Copilot instructions and prompt files, SKILL.md, DESIGN.md, and llms.txt.

12 min read · 2 October 2026
Markdown in Jira: Syntax, Examples, and Editor Limits
Guide

Markdown in Jira: Syntax, Examples, and Editor Limits

Use Markdown in Jira Cloud work-item descriptions and comments. Includes supported syntax, examples, code blocks, wiki markup differences, and fixes.

3 min read · 2 October 2026
GitHub Copilot Prompt Files: Complete .prompt.md Guide
Guide

GitHub Copilot Prompt Files: Complete .prompt.md Guide

Create reusable GitHub Copilot prompt files with .github/prompts/*.prompt.md, front matter, inputs, file references, examples, testing, and limits.

6 min read · 1 October 2026
Markdown in Microsoft Teams: Syntax, Examples, and Limits
Guide

Markdown in Microsoft Teams: Syntax, Examples, and Limits

Use Markdown-style formatting in Microsoft Teams chats and channels. Includes supported syntax, code blocks, examples, mobile limits, and fixes.

4 min read · 1 October 2026
Cursor Rules Guide: .cursor/rules Examples and Best Practices
Guide

Cursor Rules Guide: .cursor/rules Examples and Best Practices

Create effective Cursor project rules with .mdc files, rule types, globs, nested rules, examples, migration from .cursorrules, and troubleshooting.

5 min read · 30 September 2026
Windsurf Rules Guide: Examples, Locations, and Activation Modes
Guide

Windsurf Rules Guide: Examples, Locations, and Activation Modes

Create Windsurf rules with current .devin/rules and legacy .windsurf/rules locations, activation modes, AGENTS.md support, examples, and fixes.

5 min read · 30 September 2026
CLAUDE.md Guide: Complete Template and Examples
Guide

CLAUDE.md Guide: Complete Template and Examples

Learn how to write CLAUDE.md for Claude Code, with file locations, loading rules, imports, path-specific rules, a complete template, and troubleshooting.

8 min read · 29 September 2026
GEMINI.md Guide: Template, Examples, and Context Rules
Guide

GEMINI.md Guide: Template, Examples, and Context Rules

Learn how GEMINI.md works in Gemini CLI, with file locations, hierarchy, imports, memory commands, custom filenames, a complete template, and troubleshooting.

7 min read · 28 September 2026
SKILL.md Guide: Format, Template, and Complete Example
Guide

SKILL.md Guide: Format, Template, and Complete Example

Create an Agent Skill with SKILL.md. Learn the required YAML fields, folder structure, progressive disclosure, validation, security, and a complete example.

7 min read · 28 September 2026
copilot-instructions.md Guide: Template and Examples
Guide

copilot-instructions.md Guide: Template and Examples

Create .github/copilot-instructions.md for GitHub Copilot, with a complete template, path-specific instructions, scope rules, verification, and troubleshooting.

6 min read · 27 September 2026
llms.txt Guide: Format, Template, and Honest SEO Advice
Guide

llms.txt Guide: Format, Template, and Honest SEO Advice

Learn the llms.txt format with a complete example, publishing steps, validation checks, and an honest explanation of what it does not do for Google rankings.

8 min read · 27 September 2026
DESIGN.md Guide: Format, Example, CLI, and Workflow
Guide

DESIGN.md Guide: Format, Example, CLI, and Workflow

Learn how DESIGN.md gives coding agents reusable design context, with the format, an example, CLI commands, exports, common mistakes, and practical limits.

9 min read · 26 September 2026
AGENTS.md Guide: Template, Examples, and Best Practices
Guide

AGENTS.md Guide: Template, Examples, and Best Practices

Learn how to write an effective AGENTS.md, with a copyable template, monorepo rules, concrete examples, common mistakes, and maintenance guidance.

9 min read · 25 September 2026
How to Write a README in Markdown (With Template)
Guide

How to Write a README in Markdown (With Template)

How to write a README file in Markdown: what to include, a section-by-section structure, formatting with headings, badges, tables, and images, plus examples.

11 min read · 24 September 2026
Markdown in Discord: Text Formatting Guide
Guide

Markdown in Discord: Text Formatting Guide

How to format Discord text with Markdown: bold, italic, underline, strikethrough, spoilers, code blocks, quotes, headers, lists, and examples.

10 min read · 23 September 2026
Markdown in Jupyter Notebooks: Cells and Syntax
Guide

Markdown in Jupyter Notebooks: Cells and Syntax

How to use Markdown in Jupyter Notebook cells: headings, lists, tables, images, LaTeX math, and line breaks, plus how to create and render a Markdown cell.

10 min read · 23 September 2026
Markdown in Confluence: What Works, What Doesn't
Guide

Markdown in Confluence: What Works, What Doesn't

How Markdown works in Confluence Cloud: current editor shortcuts, legacy Markdown insertion, import limits, and why pages are not stored as Markdown.

7 min read · 22 September 2026
Markdown in Slack: Messages, mrkdwn, and Block Kit
Guide

Markdown in Slack: Messages, mrkdwn, and Block Kit

How Markdown works in Slack messages, app-published mrkdwn, and the Block Kit markdown block, with syntax examples and current limitations.

10 min read · 22 September 2026
Markdown in Notion: Shortcuts, Import, and Export
Guide

Markdown in Notion: Shortcuts, Import, and Export

How Markdown works in Notion: the typing shortcuts that format blocks, how to import .md files, and what happens to formatting when you export back to Markdown.

8 min read · 21 September 2026
Obsidian Markdown: Syntax, Links, Callouts, and Properties
Guide

Obsidian Markdown: Syntax, Links, Callouts, and Properties

A practical Obsidian Markdown guide covering formatting, wikilinks, embeds, callouts, properties, tags, block references, portability, and common fixes.

13 min read · 21 September 2026
Markdown in VS Code: Preview, Editing, and Tips
Guide

Markdown in VS Code: Preview, Editing, and Tips

How to write Markdown in VS Code: use preview, outline and link tools, render Mermaid and math, and understand where extensions help.

10 min read · 20 September 2026
GitHub Markdown and READMEs: A Complete Guide
Guide

GitHub Markdown and READMEs: A Complete Guide

How to write Markdown on GitHub: headings, tables, task lists, alerts, diagrams, collapsible sections, and README tips, with GitHub-specific rules.

9 min read · 20 September 2026