Skip to main content

Readma 0.6: the documentation gets a revamp

· 2 min read
elcoosp
elcoosp
Readma maintainer

The Readma documentation website has been completely rebuilt. What used to be a single landing page with a short intro is now a full documentation site.

What's new​

  • Complete guides — Getting started, workspace detection, sections & MDX and limitations now cover the full workflow.
  • CLI reference — every command (init, gen, validate, schema) with its options, exit codes and CI recipes.
  • Configuration reference — every field of ReadmeTemplateArgs documented, plus a dedicated badges & shields page.
  • Programmatic API — render readmes from your own tooling with @readma/core (API).
  • Recipes and FAQ — copy-paste configs for Deno monorepos, Rust crates, badge surgery and GitHub Actions workflows.
  • A new theme — the site now wears Readma's colors: deep navy and coral, derived straight from the logo, with light and dark modes.