Templates
An Architecture Decision Record Markdown template
Use this concise Markdown ADR template to record an architecture decision, its context, alternatives, status, and trade-offs in a project repository.
15 articles
Writing workflows
CommonMark vs GFM: Make Markdown Portable
CommonMark specifies core Markdown parsing. Learn with an example and compatibility checks.
Templates
A practical GitHub README template for a new project
A practical GitHub README template that explains what a project does, how to run it, where to get help, and how to contribute.
Templates
A Markdown Changelog Template People Can Read
Write for people upgrading the project. Learn with an example and compatibility checks.
Troubleshooting
Markdown Code Block Not Highlighting? Check Fences
Code displayed as prose and code displayed without color are different problems. Establish whether the parser recognized a fenced block first.
Troubleshooting
Markdown Images Not Showing? Fix Paths and Access
A broken image often means the asset cannot be found or accessed. Changing Markdown punctuation cannot repair a missing file.
Writing workflows
Write useful AGENTS.md instructions in Markdown
A practical AGENTS.md template for coding agents: document project context, useful commands, conventions, and boundaries without bloating instructions.
Troubleshooting
Markdown Line Breaks Not Working? Diagnose the Renderer
A newline appears in the source but disappears in the preview. First distinguish a soft break, a hard break and a new paragraph.
Troubleshooting
Markdown Links Not Working? Check Paths and Headings
Valid Markdown can still point to the wrong destination. Separate the label readers see from the address the browser actually opens.
Templates
Markdown meeting notes: a template for decisions and actions
Copy a practical Markdown meeting-notes template that separates discussion, decisions, action owners, due dates, and open questions.
Troubleshooting
Markdown Nested Lists Breaking? Check Indentation
A child item becomes code, a paragraph escapes its list, or numbering restarts. Check where the content begins relative to the parent marker.
Writing workflows
Markdown Tables: Alignment and Readable Source
Tables compare repeated attributes. Learn with an example and compatibility checks.
Writing workflows
Math in Markdown: KaTeX Syntax and Portability
Math is a renderer extension, so delimiters and commands depend on the application. Learn with an example and compatibility checks.
Writing workflows
Mermaid Flowcharts in Markdown: A Practical Workflow
Start with the process you want to explain. Learn with an example and compatibility checks.
Writing workflows
Render Markdown as HTML safely: a developer checklist
Learn how to render Markdown as HTML more safely: parse first, sanitize the resulting HTML, review extensions and links, and test the full output pipeline.
No articles match. Try a different phrase or choose All articles.