Docs pages with Cardsmith
The editor opens with the docs layout: section label, page title and product name. Docs links shared in Slack or GitHub issues then show which page they point to instead of the same homepage image.
- Set your product name and colours and save the template.
- Copy the HTML snippet into the docs theme head.
- Pass the page title, and the section as the label, from your docs tool's template variables.
- Paste a docs link into Slack or a preview checker to see the card.
What to know
Most documentation sites use one og:image for every page, so a link to an API reference looks identical to a link to the homepage. In support threads and issue trackers, where docs links are shared most, the page title on the card tells the reader where they are going before they click.
Docusaurus, MkDocs, VitePress, Starlight and Mintlify can all set a per-page meta tag from a template or front matter. Build the image URL from the page title and section and every page gets its own card without anyone making images.
Keep the subtitle short or leave it empty for reference pages; the title and section are usually enough. The docs layout gives the label its own line, so long section names do not crowd the title. Product name and colours stay the same on every card, so the set looks like one site.
Updated · Cosmovex
Questions
Which docs tools does this work with?
Any that let you change the head per page, including Docusaurus, MkDocs, VitePress, Starlight and Mintlify.
Do I need to generate images when docs change?
No. Images are drawn from the URL on first request; new pages get cards automatically.
Will 100 renders a day be enough?
Each unique URL renders once and is then served from cache for 30 days, so 100 a day covers new pages on most docs sites. Large sites can use Pro.
Is Cardsmith free?
Yes: one template and 100 renders a day, with a small Cardsmith badge on the card. Pro removes the badge and allows 20 templates and 10,000 renders a day.
The free plan covers everything on this page. Cardsmith Pro ($9/mo, billed monthly) is described on the Cardsmith page.
