Markdown, README and Mermaid tools online

Project Documentation

These tools help you write the documents that come with a code project. Generate a README or start from an example, build badges, fill in an API reference, build a changelog and release notes, and check or bump a version under Semantic Versioning 2.0.0.

Tools in this group

  • API Documentation Template — Fill in your API's authentication, errors and endpoints and get a Markdown reference with a table of contents and a curl example for every endpoint.
  • Changelog Template (Keep a Changelog Editor) — Build a CHANGELOG.md in the Keep a Changelog 1.1.0 format: add entries, release Unreleased as the next version, generate compare links, or paste a changelog to check it.
  • How to Write a README (with a README Checker) — Paste your README to see what is missing: title, description, install, usage, license, contributing, contents, heading levels, broken #links and image alt text.
  • OpenAPI Example Specs (YAML and JSON) — Pick a complete OpenAPI document and copy it as YAML or JSON, or paste your own spec to check it and turn it into Markdown docs.
  • GitHub README Badge Generator — Build shields.io badges for your README — static text badges or live GitHub, npm, PyPI, Docker and Codecov badges — and copy Markdown, HTML, URL or reStructuredText.
  • README Examples and Templates — Pick one of eight complete README.md examples, fill in your name and project, then copy or download it.
  • README Generator — Fill in your project name, description and the sections you need, and get a ready-to-commit README.md with badges, install commands and a table of contents, updated as you type.
  • Release Notes Template — Pick a preset, fill in what changed, and get release notes as Markdown or plain text — or paste Conventional Commits subjects to sort them into sections.
  • Semantic Versioning (SemVer) Calculator — Check a version against Semantic Versioning 2.0.0, bump it, compare or sort versions, or test a version against an npm range such as ^1.2.3.