Blog - #documentation

Markdown guides, tutorials, and tips for developers, writers, and students.

All
documentation

Markdown Citations: References and a Bibliography (2026)

Add a markdown citation three ways: Pandoc keys with a .bib file and a CSL style, GitHub-safe footnotes, or an attributed quote. Try our free editor.

September 11, 2026·10 min read

mdBook: Build Documentation Sites from Markdown

mdBook (md book) guide from install to GitHub Pages: SUMMARY.md and book.toml line by line, supported Markdown syntax, and PDF output. Try our free editor.

September 11, 2026·10 min read

Markdown Guidelines: A 20-Rule Style Guide (2026)

Markdown guidelines for clean, consistent files: 20 rules with the reason for each, the markdownlint ID that enforces it, and a config to copy. Try our editor.

September 11, 2026·9 min read

Docusaurus Markdown: Syntax Beyond Standard GFM

Docusaurus Markdown in one page: admonitions, tabs, code block titles and line highlighting, front matter, heading IDs, and the MDX pitfalls to avoid. Try free.

September 11, 2026·10 min read

MkDocs Markdown: Write and Publish Docs with MkDocs

MkDocs from install to gh-deploy: a copy-paste mkdocs.yml, the extensions you need, how its Markdown differs from GitHub, and release status. Try our editor.

September 11, 2026·10 min read

Markdown Documentation: Write Docs in Markdown (2026)

How to write markdown documentation: folder structure, a docs page template, an API endpoint template, and when to use MkDocs or Pandoc. Try our free editor.

September 11, 2026·10 min read

MDX Markdown: JSX Components in Markdown Explained

Learn what MDX markdown adds to plain Markdown, which syntax breaks when you rename .md to .mdx, and what a normal editor still renders. Try our free editor.

September 11, 2026·10 min read

README Markdown: How to Write a Great README

Write a great GitHub README with this markdown guide. Covers essential sections, badges, templates, screenshots, and Mermaid diagrams. Free template included.

May 6, 2026·6 min read

Markdown Table of Contents: Manual and Auto Methods

Add a table of contents to markdown files manually or with auto-generation tools. Works with GitHub, VS Code, Jekyll, and Hugo. Copy-paste examples.

April 9, 2026·6 min read

Markdown Comments: How to Add Hidden Comments

Add comments in markdown using HTML comment syntax. Hidden from rendered output but visible in source. Works in GitHub, VS Code, and all markdown editors.

April 9, 2026·7 min read