Documentation
Reference
This section contains the reference material for ctrl alt doc.
Feature showcase #
Built-in Icons
Use ctrl alt doc's built-in Hugeicons Stroke Rounded icon set.
Callouts
Highlight important information with configurable callout blocks.
Cards
Group related links into visual cards.
Code
Add syntax-highlighted and copyable code blocks to your documentation.
Details
Hide supporting information inside expandable details blocks.
Documentation Cards
Automatically generate cards from documentation pages.
Downloads
Add downloadable resources to your documentation.
Figures
Display images with captions.
File Trees
Show project and directory structures visually.
Frontmatter
Configure document metadata and navigation behaviour.
Kitchen Sink
A showcase of the documentation features built into ctrl alt doc.
Links
Link between documentation pages and external resources.
Markdown
Write documentation with standard Markdown.
Navigation
Organise documentation into pages and categories.
Steps
Present a process as a clear, numbered sequence.
Svelte Components
Use user-owned Svelte components directly in ctrl alt doc Markdown.
Table of Contents
Automatically generate a table of contents from document headings.
Tabs
Group related content behind an accessible tab interface.
Kitchen sink #
Everything implemented in the current release is demonstrated on the Kitchen Sink page.