Workspace Docs

Appearance

VitePress Features

Что здесь ​

Autodoc генерирует обычный markdown для VitePress, поэтому документация может использовать не только наши helpers, но и нативные возможности VitePress: snippets, regions, code groups, Vue-компоненты и callouts.

Code groups ​

VitePress tabs для code blocks называются Code Groups. Они удобны, когда оба состояния примера остаются кодом: например, показать markdown, который пишет автор страницы, и результат, который VitePress отрендерит ниже.

Region snippets ​

VitePress region snippet позволяет показать в документации живой кусок исходного файла. В source ставятся маркеры // #region name и // #endregion name, а в markdown пишется <<< @/generated-snippets/path/to/file.ts#name. VitePress берёт всё внутри region и рендерит это как обычный code block.

Autodoc автоматически сканирует sourceRoot и pagesRoot и копирует все файлы, содержащие #region-маркеры, в generated-snippets. Для файлов внутри sourceRoot путь считается относительно sourceRoot: src/export-space.ts становится generated-snippets/export-space.ts.

ts
// #region define-doc-space
export function defineDocSpace<TConfig extends DocSpaceConfig>(config: TConfig): TConfig {
  return config;
}
// #endregion define-doc-space

В markdown страницы:

md
<<< @/generated-snippets/export-space.ts#define-doc-space
ts
export function defineDocSpace<TConfig extends DocSpaceConfig>(config: TConfig): TConfig {
  return config;
}

Mentioned In ​

None yet.