Skip to content
svedocs

Content

Author pages with frontmatter, GFM, KaTeX, code blocks, and table of contents extraction.

svedocs scans .md, .mdx, and .svx files from configured content roots and turns them into pages, headings, search records, and metadata.

Frontmatter

Markdown
---
title: Content
description: Explain the content pipeline.
---

The common fields are title, description, order, hidden, collapsed, icon, canonical, image, published, and updated.

Markdown

  • Tables, task lists, and autolinks.
  • KaTeX for inline and block math.
  • Heading anchors and automatic table of contents extraction.

Code blocks

TypeScriptsvedocs.config.ts
import { defineConfig } from 'svedocs/config';

export default defineConfig({
  site: { name: 'svedocs' }
});

Code blocks support syntax highlighting, metadata, line highlighting, focus hints, diff markers, wrapping, and copy actions in the default theme.

Diff

Diff+1-1
- const docs = fragmented();
+ const docs = svedocs();
packages/svedocs/src/core.ts +2 -1
Before
After
@@ -1,3 +1,4 @@
1 export * from './content.js';
1 export * from './core/content.js';
2 export * from './core/navigation.js';
2 export * from './config.js';
3 export * from './config.js';

Section extraction

Section headings become search targets and on-page navigation entries automatically, so long guides still stay easy to scan.