Markdown examples
Whole documents rather than fragments. Each one is a template worth starting from, and each opens in the viewer in one click.
- README exampleThe document every repository needs and most repositories get wrong by leaving out the two things a visitor actually wants: what it is, and how to run it.43 lines
- Changelog exampleA changelog is written for humans, not from git log. This is the Keep a Changelog convention, which is what most projects follow.40 lines
- CLAUDE.md exampleA CLAUDE.md sits in the root of a repository and tells a coding agent how this project works. The same shape works as AGENTS.md, which other tools read.31 lines
- Blog post exampleWhat a post looks like for Hugo, Astro, Jekyll or Eleventy: metadata at the top between three dashes, then the article.39 lines
- API documentation exampleOne endpoint, documented the way a developer wants to read it: what it does, what it takes, what comes back, and what goes wrong.52 lines
- Meeting notes exampleNotes people will actually read afterwards: what was decided, and who does what next. Everything else is optional.28 lines
- Resume exampleA CV in markdown keeps well in git, diffs cleanly and converts to a decent PDF in one step. This is a plain structure that survives that conversion.41 lines