Home

Readmint

Generated from the docs/ folder of the repository. Edit it there; changes made on the wiki are overwritten.

Design your README. Any font, any data, any style. Readmint renders README graphics from designs you make yourself and keeps them current with a GitHub Action in your own repository.

Ready-to-copy workflows and designs: the examples repository.

Reading route

1. See it first: every template rendered, light and dark, before you install anything. Begin with Gallery.
2. Start here: from nothing to a rendered design in your README. Begin with Getting started.
3. Guides: how to do one thing well. Begin with GitHub Action.
4. Reference: the formats and languages, exactly. Begin with Design format.
5. Contributors: working on Readmint itself. Begin with Golden tests.

See it first

• Gallery: the profile, starter, calendar and source card templates rendered in light and dark

Start here

• Getting started: a design, a workflow, a README snippet, and the examples repository

Guides

• GitHub Action: inputs, outputs, pushing, errors, releases
• Components and templates: the starter templates and the contribution calendar
• CLI: render, validate and preview on your machine
• Editor: the visual editor
• Fonts and licensing: your own fonts and when they are embedded
• Asset loading: which files and images a design may load
• Troubleshooting: common failures and where to look

Reference

• Design format: layers, assets, animation, JSON Schema, versioning
• Expressions: placeholders, filters and functions
• Data sources: the data object a design binds to
• GitHub data: what the GitHub source provides, privacy, errors
• Output formats: SVG, PNG, WebP, APNG and GIF
• Renderer: how a design becomes an SVG

Contributors

• Golden tests: the golden-image and SVG snapshot suites
• Wiki publishing: how these pages are generated and published

Source of these pages: docs/