Repository navigation
feat(astro): changelog ids per entry, authoring docs, optional credit line - #31
Merged
Merged
Conversation
… line The changelog page rendered every entry's MDX on its own, so two releases with an "Added" section both had id="added" (and their footnotes collided the same way). Heading and footnote ids inside an entry are now scoped to it (#v0-2-0-added), with the links and ARIA references that point at them, and entries whose files share a name get distinct anchors, the oldest keeping the plain one. A version written as v1.2.0 no longer shows as vv1.2.0, and the date is a <time> element. The README documents how to write entries: file names, frontmatter, status, anchors, grouping under ### headings. The format is the Next.js themes' own. A new `credits` option adds a small "Built with Inkform" link to the repository under each page, outside the search index. It's off by default, like the integration's other additions to what readers see. The example's changelog uses grouped sections, and it turns credits on; e2e tests check both. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_011YQ6fJxGHg3CxGkTzw6Yhc
|
The latest updates on your projects. Learn more about Vercel for GitHub. 2 Skipped Deployments
|
This branch was previously deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Covers the changelog gaps in
@inkform/astroand adds an optional "Built with Inkform" credit.Changelog: what was already there, what was missing
The route, the page and the format already existed. With entries in
content/changelog/, the integration serves<base>/changelog, adds a header link, lists the page inllms.txtand includes the entries inllms-full.txt. The format is the same as the Next.js themes'/changelog. Compared with the Next.js page, nothing was unwired. Two things were missing:### Addedsection producedid="added". GFM footnotes collided the same way. Now:#v0-2-0-added), along with the#links andaria-describedby/aria-labelledbythat point at them (scopeIds());2026-01-05-update.mdx,2026-02-09-update.mdx) get distinct anchors. The oldest keeps the plain one, so links don't move when a newer entry is added (changelogAnchors()).version: v1.2.0no longer shows asvv1.2.0, and the date is a<time>element.YYYY-MM-DD-<slug>.mdx), the frontmatter (title,date,version,status: draft/scheduled,tags), anchors, grouping under###headings, and where entries show up.Credit
There was no credit anywhere in the repo. This adds
credits: true, which shows a small, muted "Built with Inkform" link under each docs page, after prev/next. It links to https://github.com/inkform-dev/framework, the repo@inkform/astrolives in, and is markeddata-pagefind-ignore="all"so search doesn't index it.Off by default, because:
baseand nothing else";mermaid: false);The option name follows Starlight's
credits, which Astro users will recognise.Example and tests
examples/astro-docs: both changelog entries use grouped### Addedsections, and the example turnscreditson.changelogAnchors,versionLabel,scopeIdsacross two rendered entries with footnotes, and thecreditsoption.The CHANGELOG has Unreleased entries. No version bump.
Test plan
npm test --workspace=@inkform/astro: 79 pass.npm run typecheckfor@inkform/astroand the example: 0 errors.npm run test:e2e --workspace=@inkform/example-astro-docs: 38 pass./docs/changelogand of the credit line under/docs/quickstart.🤖 Generated with Claude Code
https://claude.ai/code/session_011YQ6fJxGHg3CxGkTzw6Yhc