Repository navigation
Releases
Releases · tilaven/inkan
v0.2.0
Breaking
- The interface is English only. The
localeandtranslationsoptions (in the config and in plugins) and the@tilaven/inkan/i18nexport are removed. A config that still setslocaleortranslationsnow fails with "unknown option": delete those lines. Sites that never set them see no change.
New
- Landing page options for a product-style home page:
landing.eyebrow,landing.image(with a separate picture for the Stage theme),landing.commandwith a copy button, andlanding.featurescards._landing.mdfront mattertitleanddescriptionreplace the "Content" heading. Defaults are unchanged. - Open Graph card for the home page uses the landing picture and tagline.
- Authors page shows each person's five newest records with a "See N more" link.
Fixed
- Covers within one project are easier to tell apart: each record gets its own framing.
- Right-aligned table columns no longer run into the next column.
- Long ids on
/export/no longer overlap the titles. - Placeholder text such as
<record title>in a record is shown as written instead of disappearing. - A table that widens after web fonts load stays a focusable scroll region.
Docs
- The documentation now lives at useinkan.dev
npm create @tilaven/inkan@latest my-decisions
# or, in an existing site
npm install -D @tilaven/inkan@0.2.0v0.1.1
v0.1.0
The first public release of Inkan: a docs site for your Architecture Decision Records and RFCs, built from plain Markdown in your repo. One site for every team, a printed cover for every record, and one place to find out why things are the way they are.
Get started
npm create @tilaven/inkan@latest my-decisions
cd my-decisions && npm install && npm run devOr add it to an existing repository with npm install -D @tilaven/inkan && npx inkan init. Requires Node.js 22.22 or newer.
Highlights
Writing
- GitHub and GitLab flavoured Markdown, Mermaid, math, code highlighting, alerts and admonitions
- Record type comes from the folder (
adr/,rfc/or your own), with status lifecycle, supersedes and related records - Custom metadata fields validated at build time and filterable on the index
- Dates and authors from git, issue keys turned into links,
@adrreferences from your code
Reading
- Full-text search with Pagefind, or Algolia, Meilisearch, Typesense and your own provider
- Filters by team, type, status, author, tag and custom field, kept in the URL
- Landing page, timeline, decision graph, authors and tags, RSS and sitemap
- Status history from git, Open Graph cards, print and PDF export
- Day and Stage themes, WCAG 2.2 AA, interface in English and Polish
Running the process
- Open decisions with deadlines, periodic reviews and RFC reviews with a "Waiting on you" view
- Comments with giscus, GitLab or your own provider
inkan checkfor CI, Slack, Teams and webhook notifications- Records synced from other repositories, sign-in and protected projects
- Import from log4brains, MADR and adr-tools
For agents
llms.txt,decisions.jsonand a Markdown copy of every pageinkan mcp, an MCP server over your content or a published site
Extending
- Plugins, component overrides and slots, custom pages, a data API and
--inkan-*CSS tokens
Packages
[@tilaven/inkan](https://www.npmjs.com/package/@tilaven/inkan)0.1.0: theinkanCLI and the site[@tilaven/create-inkan](https://www.npmjs.com/package/@tilaven/create-inkan)0.1.0: the project starter
Both are published from GitHub Actions with npm provenance.
This is a 0.x release: the configuration and plugin APIs may still change between minor versions. Feedback and issues are very welcome.