Releases
Release notes for @carrotsearch/eleventy-apidocs — a short
summary of what each version contributed. The dates come from the
<time> element on each section; the theme fills in the
readable form from its datetime attribute.
0.1.18
Reliable link checking on busy machines, and a tighter API search filter.
- Link-check concurrency cap
-
The post-build link check now fetches at most 16 URLs at once instead of the hundreds linkinator would launch eagerly, and the new
concurrencyfield of thelinkCheckoption adjusts the cap. The crawler, its static server and the files it serves share one process, so an unbounded crawl could exhaust file descriptors under load and fail the build with false 404s for pages that exist. - Tighter API search filter
-
A single-word query no longer scatters across unrelated symbols, such as
rematchingvariables. The region filter now rejects mid-word scatter for one-word queries while still admitting initialism and prefix matches (lbc→labelBoxColor). - Dependency maintenance
-
Updated Biome and the production dependencies.
0.1.17
Configurable search result caps, and a dedicated configuration reference.
- Cap and size the search result groups
-
The new
searchLimitsoption sets how many results each group shows — with per-kind sub-caps inside the API group — andsearchFetchLimitsizes the candidate pool the results are drawn from. - Configuration reference page
-
Every
eleventy.config.jsoption now has a full write-up on a dedicated Configuration page; Getting started keeps just the handful most sites set up front.
0.1.16
Search refinements: a way to order the API results, and a fix for pages that are themselves API elements.
- Order the API search group by kind
-
The new
apiKindOrderoption lists thedata-api-kindvalues that should sort to the front of the API results — everything else follows in relevance order. A site whose API is built from, say, stages and components can surface those ahead of individual methods and options. - No duplicate hit for an API-element page
-
When a page’s top-level
<article>is itself an API element, it no longer appears twice in search — once under “API” and again under “Pages and sections.” The more specific API hit is kept.
0.1.15
Fixes for the navigation menu’s scroll position and section highlighting.
- Navigation scroll position now restores reliably
-
The navigation menu keeps its scroll position when you move between pages every time. Previously it could occasionally jump back to the top, depending on how quickly the page finished loading.
- Expanded section links highlight as you scroll
-
On a page whose sections are listed in the navigation menu, the highlight now follows the section you’re reading as you scroll or click, instead of staying on the page’s top-level entry.
- Dependency maintenance
-
Updated build and lint tooling (Biome 2.5, undici, esbuild) and cleared transitive security advisories.
0.1.14
Build progress now renders in place on an interactive terminal, and the navigation menu keeps its place when you move between pages.
- In-place progress reporting
-
When you run a build in a terminal, its steps now appear as a single summary that updates in place — bundling, page rendering, link checking and the rest — rather than a long scrolling log, with the time each step took shown alongside it. The first
--servebuild shows the same summary. When the output is captured instead — piped to a file, or running in CI — the build prints plain lines.Set
APIDOCS_VERBOSE=1, or run the sample site’sbuild:verbosescript, for a detailed line-by-line log of every step instead. - Navigation remembers its scroll position
-
On sites with a long navigation menu, scrolling down and opening a page no longer jumps the menu back to the top. The menu stays exactly where you left it, so you keep your place in the list as you move from page to page.
0.1.13
More complete build progress reporting.
- Fuller build progress
-
Navigation derivation and link checking now report their own progress as the build works through them, so the phases between page rendering and the final summary no longer look stalled on a large site.
0.1.12
Expandable navigation entries, a live build progress counter, and quieter, more reliable builds.
- Expandable navigation entries
-
A navigation entry can now expand a page’s sections into the sidebar, listing them as links right beneath the page. A long page — a command list, a settings reference — then reads like a chapter whose pages are its own sections.
- Live build progress
-
The build now reports a running count of pages as they render, so a large site no longer looks stalled while it works.
- Quieter, more reliable builds
-
Link checking no longer reports generated image sizes as broken links, and the build prints fewer spurious warnings. The “On this page” heading now lines up with the entries below it.
0.1.11
Configurable code themes, group labels in the main navigation, and edge-to-edge code boxes on mobile.
- Configurable code themes
-
The new
codeThemesoption sets the themes used to syntax-highlight code blocks, with independentlightanddarkvalues. - Navigation group dividers
-
A chapter in the navigation manifest can carry an optional
sectionlabel that groups the chapters beneath it. - Collapsible “On this page” on narrow viewports
-
Below the breakpoint where the “On this page” list drops its dedicated rail, it now appears as a collapsible panel at the top of the content instead of disappearing, so in-page links stay available on smaller screens.
- Mobile layout refinements
-
The mobile gutter is tightened so code boxes sit flush with the edge with squared corners, and the hamburger toggle is realigned.
0.1.10
The build now checks its own links.
- Built-in link checking
-
After a full build the theme crawls the generated site for broken links — both 404s and in-page
#anchortargets that don't exist — and fails the build if any turn up. External links are skipped by default so a third-party outage can't break your build. Configure or disable it with thelinkCheckoption.
0.1.9
Faster builds, cleaner search navigation, and self-cleaning images.
- Markdown siblings reuse processed images
-
The
.mdsibling of each page now reuses the image URLs the HTML pipeline already resolved instead of running every image through eleventy-img a second time, so builds with images are faster. - Cleaner search-result links
-
Symbol and section search hits no longer append a
pagefind-highlightquery to their links: a fuzzy query (e.g.lbc→labelBoxColor) rarely matches literal prose, so the highlight only scattered stray marks. The hits still jump straight to their#anchor. - Stale image variants are pruned
-
After a full build, any generated variant under
assets/apidocs/imgthat the build didn't emit is deleted, so a changed or removed source image leaves no orphaned files behind in the output (or in a restored CI cache). - CI caches generated variants
-
The sample workflows now persist
assets/apidocs/imgacross runs; eleventy-img re-encodes only new or changed images, and the prune above keeps the cache free of orphans.
0.1.8
Refinements to the section target manicule.
- Constant-size section manicule
-
The manicule marking the active section is now a constant size, centered vertically against the heading, instead of scaling with the heading's font size — large headings no longer push it into the main navigation scrollbar.
- No link icon on the active section
-
The hover/focus anchor link icon is suppressed on the active section, where the manicule already marks it.
0.1.7
This release notes page itself, plus the date handling that powers it.
- Rendered
<time>datelines -
A
<time datetime="YYYY-MM-DD">left empty now renders a readable date — the machine date lives in the attribute and the theme derives the text, so the two can't drift apart. A<time>with its own text is left untouched. - Releases page
-
The sample site gains this Releases page as a worked example of the dateline pattern.
0.1.6
Responsive images move to a browser-driven model and the lightbox upgrade gets smoother.
- Browser-picked image resolution
-
Article images now ship a low-res variant via
sizes=autoand let the browser request a higher-resolution source on demand — the lightbox upgrades to the hi-res variant when you zoom. - Cross-fading lightbox zoom
-
Zooming an image cross-fades up to the hi-res source instead of snapping between resolutions.
- Theme survives hot reloads
-
The dev server re-applies the persisted light/dark theme after a hot update, so it no longer flashes back to the default mid-edit.
0.1.5
A lightbox reliability pass plus housekeeping on code complexity and dependencies.
- Lightbox transition fixes
-
The zoom now locks the cloned image to an explicit pixel box and decodes the upgraded source before animating, fixing the races and flicker that could appear on open and close.
- Cognitive-complexity gate
-
Biome's
noExcessiveCognitiveComplexityrule is enabled at a threshold of 15, and three functions were simplified to clear it. - Dependabot
-
A Dependabot config keeps the npm and GitHub Actions dependencies up to date.
0.1.4
Small authoring and build improvements.
httpcode highlighting-
httpjoins the code-highlighting language allowlist, so request/response snippets get highlighted. - Two-column definition lists
-
Definition lists only switch to their two-column layout below the article's maximum measure, so they don't crowd narrow text columns.
0.1.3
CI moves to the Node 24 majors and the search code is refactored into two named query paths — no change in behavior.
0.1.2
Search dialog polish.
- Keyboard-shortcut hints
-
The search dialog footer advertises its keyboard shortcuts, and the input placeholder describes what's searchable.
- Version from the manifest
-
The sample site derives its
0.1.18from the package manifest instead of hard-coding it.
0.1.1
First published release of the theme. It ships the full pipeline: HTML-source articles, code blocks, responsive images with a zoom lightbox, navigation and table of contents, unified Pagefind + fuzzysort search, callouts, prev/next links, cross-document View Transitions, and a test suite wired into CI.