Blog - #documentation

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

documentation

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

github

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

syntax

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