ctrl doc

Changelog

Changes and improvements released since ctrl alt doc 1.0.0.

v1.0.7 #

Added #

  • Added the documentation API response fields needed by integrations, including rendered content, Markdown, table of contents, section and breadcrumb data.
  • Added question-style search, typo tolerance, and heading-aware results that link directly to the matching section.
  • Added integration documentation for the Discord bot and its API endpoints.

Improved #

  • Sidebar categories with an index.md page now expand when needed and still navigate to their category landing page when the label is clicked.
  • Generated projects use the current framework release.
  • Refined base styling for brand logos, figures and pagination.

Package versions #

  • ctrl-alt-doc@1.0.7
  • create-ctrlaltdoc@1.0.7

v1.0.6 #

Added #

  • Added the expanded /api/page response with a document's table of contents and rendered content.
  • Added the API fields needed by integrations to link to specific headings.

Improved #

  • Sidebar categories can be expanded or collapsed from their label as well as their disclosure control.
  • Refined base styling for brand logos, figures, and pagination.

v1.0.5 #

Fixes #

  • Fixed duplicate heading IDs and kept route-level tables of contents aligned with rendered anchors.
  • Added regression coverage for repeated headings.

v1.0.4 #

Fixes #

  • Fixed imported Svelte components not rendering inside Markdown table cells.
  • Added regression coverage for Svelte component placeholders in tables.
  • Preserved normal inline Markdown formatting within table cells.

v1.0.3 #

Added #

  • Added GitHub Packages publishing for the framework and project creator packages.
  • Added generated-project support for the updated bundled documentation and template presentation.
  • Added improved installation guidance and template examples.

Fixes #

  • Fixed duplicate heading links in the table of contents.
  • Fixed route-level TOCs drifting from the renderer-generated heading IDs.
  • Improved development hot-reload handling while Markdown files are being saved.
  • Updated the production workflow to use Node.js 22.

Improved #

  • Refined the bundled documentation layout and visual presentation.
  • Improved Steps documentation and examples.
  • Improved generated-project route and document handling.
  • Updated package metadata and GitHub repository links.

v1.0.2 #

This release improves navigation, documentation cards, external links, serverless deployment, development asset handling, and package update visibility.

Added #

  • Added New, Updated, and Beta badges.
  • Page badges now appear in sidebar navigation.
  • Page badges now appear on generated documentation cards.
  • Category badges can be configured through _category.yml.
  • Added automatic package update notifications during npm run dev.
  • Update notifications detect npm, pnpm, Yarn, and Bun.
  • Added ExternalLinkIcon to external Markdown links, cards, and footer links.
  • Added documentation covering badges, external links, documentation cards, and update notifications.
  • Added build-time documentation bundling for serverless and edge deployments.

Fixes in place #

  • Fixed :::doc-cards rendering an empty container on the homepage.
  • Direct child directories containing an index.md document now appear as homepage documentation cards.
  • Fixed homepage slug normalization in the Svelte-aware Vite transform.
  • Fixed access to project-root assets such as custom.css during local development.
  • Fixed Cloudflare Workers deployments requiring the source docs/ directory at runtime.
  • Fixed transient missing-file errors during replace-style Markdown saves in Vite development.
  • Preserved existing documentation-card styling and Markdown behavior.
  • External web links now open in a new tab.
  • External links now include rel="noopener noreferrer".
  • Internal links and heading links continue to open in the current tab.

Update notifications #

When a newer version is available, running the development server now displays an update notice:

text 
┌  ctrl alt doc update available
│
│  1.0.1 → 1.0.2
│
│  Run: npm update ctrl-alt-doc
└

The update check:

  • runs only during local development
  • runs at most once every 24 hours
  • does not delay development-server startup
  • fails silently when the npm registry is unavailable
  • is disabled automatically in CI
  • never runs during production builds

Disable it manually with:

bash 
CTRL_ALT_DOC_DISABLE_UPDATE_CHECK=1 npm run dev

Package versions #

This release is distributed through:

  • ctrl-alt-doc@1.0.2
  • create-ctrlaltdoc@1.0.3

The intermediate create-ctrlaltdoc@1.0.2 release was deprecated because npm removed its executable metadata during publication. Use 1.0.3 or newer.

Updating an existing project #

With npm:

bash 
npm install ctrl-alt-doc@latest

With pnpm:

bash 
pnpm update ctrl-alt-doc@latest

Restart the development server after updating.

You do not need to update create-ctrlaltdoc in an existing project. The scaffolder is only used when creating a new project.

v1.0.1 #

Repaired #

  • Allowed generated projects to serve project-root assets during development.
  • Fixed Vite filesystem allow-list errors affecting custom.css.
  • Confirmed the issue only affected the development server and HMR.
  • Production builds and deployed output were unaffected.

v1.0.0 #

The first public release of ctrl alt doc.

Included #

  • Markdown documentation pages
  • Frontmatter
  • Automatic navigation
  • Sidebar categories
  • Search
  • Table of contents
  • Breadcrumbs
  • Pagination
  • Callouts
  • Steps
  • Tabs
  • Cards
  • Documentation cards
  • File trees
  • Downloads
  • Figures
  • Code highlighting and copying
  • Built-in Hugeicons
  • Configurable framework-owned SVG icons
  • User-owned Svelte components in Markdown
  • Server-side rendering
  • Production builds
  • Project scaffolding through create-ctrlaltdoc