cloudflare/nimbus @cloudflare/create-nimbus-docs@0.8.0

@cloudflare/create-nimbus-docs@0.8.0

Repository: cloudflare/nimbus

Tag: @cloudflare/create-nimbus-docs@0.8.0

Published: 2026-10-22T23:00:16Z

Prerelease: no

Release notes:

Minor Changes

• #273 `352a245` Thanks @MohamedH1998! - A redesigned API reference:

• The API home lists every endpoint, grouped by x-tagGroups, with a filter; large specs load in parts as you scroll. The API route serves the later parts at /api/index/2/ and on, noindex and left out of the sitemap and search; it takes the part size as homeChunkSize in both getApiStaticPaths and getApiRoute (without it, the home is one page), and getApiRoute returns the parts as home.
• Section pages list their endpoints name first, with the method and path beneath.
• The API version picker sits in the header, at every width.
• Code rail lines sit on whole pixels, with quieter line numbers; section titles are in full ink.
• The API sidebar's rows match the docs sidebar's.
• Section page operations gain method, path, description and deprecated, and the root page gains an index of every endpoint.
• getApiRoot reads an API version's root page from any route; chunkApiIndex and apiIndexRows split and flatten its index.

nimbus-docs migrate lists the optional steps to adopt it.

• #274 `961e85d` Thanks @MohamedH1998! - - New sites' share cards show the site's logo, the page's section and its title, on white. A long title shrinks before it's cut and stays within three lines.
• The card's look lives in the site's src/pages/og/_card.ts; the logo is drawn once, in src/components/logo.ts, for the header and the cards.
• @cloudflare/nimbus-docs/og fits text by measuring it and renders cards to PNG. It needs satori and @resvg/resvg-js, optional peers.
• getPageSection(page) returns the label of a page's nearest parent, from the sidebar for docs pages and from the spec for API pages.

• #274 `91eb2e9` Thanks @MohamedH1998! - - Card takes href: the whole card becomes the link.
• Diagram buttons and controls keep their 32px height inside prose.
• PUT and PATCH method chips meet 4.5:1 contrast in light mode.
• The version picker and the API field toggle are named by their visible text.

• #272 `9a65f9f` Thanks @MohamedH1998! - New sites start on the redesigned starter:

• A fill-in Introduction as the home page, a Writing pages guide and a Components page replace the sample pages and the landing page.
• A new type scale, steel accent, code blocks, sidebar and header logo.
• One pagination bar for the previous and next pages; with focus in the bar, [ and ] move between them.
• Every component part has a data-slot to style it by, except sidebar rows, which stay bare so large sidebars stay light.
• Components wrap long words, URLs and labels instead of overflowing on phones.
• Text meets 4.5:1 contrast in light mode, Steps are a real list, manual Tabs render one tab list and pair each tab with its panel.
• Pages mirror correctly in right-to-left languages; code stays left to right.
• On phones, sites with several sections show them as tabs under the header.
• Thin, theme-coloured scrollbars.
• PageActions renders extra actions passed as children; the layout passes the Copy MCP URL action that way.

Existing sites keep their look. nimbus-docs migrate lists optional steps to adopt it, the lighter sidebar rows, and the new favicons and asset caching. The registry adds a variants lib that Badge and Button install with them.

• #278 `b6d4837` Thanks @MohamedH1998! - - Route files say how they render. nimbus-docs check reports each route Nimbus manages whose file disagrees with rendering, and check --fix rewrites it: the prerender line, getStaticPaths on built routes only, and the collection name in a collection route's page helper. Without rendering, Nimbus builds every one of these routes ahead of time, a collection route such as src/pages/sdk/[...slug].astro included. rendering still wins at build, which now warns once and lists the files.
• A built dynamic route with no getStaticPaths fails the build, naming the file; Astro can't build it.
• The page helpers take the collection as a second argument, such as getCollectionPage(Astro, "sdk") or getApiRoute(Astro, "api", { homeChunkSize }), so a request-rendered route needs no getStaticPaths to say which collection it serves. A route whose getStaticPaths and helper name different collections fails with nimbus/collection-route-mismatch.
• add adapter-* updates route files after setting rendering, and its recipes run check --fix.
• outdated and diff compare starter route files in the site's own mode, so a route check --fix edited doesn't read as a local change.
• The starter's Markdown, llms.txt and docs page routes drop export const prerender = true; the site's output and rendering decide how they render. A scaffold with a server adapter writes its route files in the mode its rendering gives them.

• #284 `f256109` Thanks @MohamedH1998! - - A new site can include an API reference: --api adds one at /api, from your OpenAPI 3.x file (--api ./openapi.yaml) or a sample, and --template api makes it the whole site, at /. Without flags, the scaffolder asks what the site includes, and it refuses a spec that isn't OpenAPI 3.x before writing anything.
• AGENT.md in a site with an API reference says where its spec and route are; a site that is only the reference has no...