A documentation framework takes shape
The core documentation experience is now functional, bringing together the pieces needed
to build a complete documentation site.
01
The documentation experience
Documentation rendering
Markdown documentation can now be rendered as a complete documentation experience.
Navigation
Sidebar navigation supports categories, active documents and category pages, with
parent categories automatically opening when they contain the active document.
Search
Documentation can now be searched directly from the site.
Table of contents
Documents can provide an automatically generated table of contents.
Breadcrumbs
Document hierarchy is reflected through breadcrumbs.
Document pagination
Previous and next document navigation makes moving through documentation
straightforward.
02
The authoring experience
Callouts
Configurable callouts are built into the documentation experience, including
support for the built-in icon system.
Built-in icons
A built-in icon registry now provides 39 icons across UI, navigation, actions,
development and social categories.
Syntax highlighting
Code blocks are syntax-highlighted using Shiki.
Copy code
Code blocks include built-in copy functionality.
03
The project
Navigation badges
Sidebar items can display New and Updated badges.
Custom CSS
Projects can provide their own custom.css file for CSS overrides.
Configurable footer
The documentation footer can be enabled and configured at project level.
Configuration
The ctrlaltdoc.config.ts file establishes the foundation for configuring a documentation site without modifying
the framework itself.