@rspress/plugin-typedoc
Исходный код

Плагин Rspress для интеграции TypeDoc и автоматической генерации API-документации для модулей TypeScript.

Установка

npm

yarn

pnpm

bun

deno

npm add @rspress/plugin-typedoc -D

Использование

import { defineConfig } from '@rspress/core';
import { pluginTypeDoc } from '@rspress/plugin-typedoc';
import path from 'path';

export default defineConfig({
  plugins: [
    pluginTypeDoc({
      entryPoints: [
        path.join(__dirname, 'src', 'foo.ts'),
        path.join(__dirname, 'src', 'bar.ts'),
      ],
    }),
  ],
});

src/foo.ts

/**
 * Это функция сложения (add).
 */
export function add(
  /**
   * Это param1.
   */
  param1: string,
  /**
   * Это param2.
   */
  param2: number,
) {
  return 1;
}

src/bar.ts

/**
 * Это функция умножения (multi).
 */
export function multi(
  /**
   * Это param1.
   */
  param1?: string,
  /**
   * Это param2.
   */
  param2?: number,
) {
  return 1;
}

Когда вы запускаете или собираете проект, плагин автоматически создаёт директорию api в корне документации. Структура этой директории:

api

_meta.json

index.md

functions

bar.multi.md

foo.add.md

interfaces

foo.RunTestsOptions.md

foo.TestMessage.md

modules

bar.md

foo.md

Плагин внутренне вызывает TypeDoc для генерации API-документации ваших модулей, включая список модулей, описание интерфейсов и сведения о функциях — такие как параметры, возвращаемые значения и описания.

Обратите внимание, что файлы документации .md перегенерируются каждый раз при запуске проекта, чтобы отражать актуальное содержимое модулей. Поэтому мы рекомендуем добавить файлы .md в директории api в .gitignore, например: docs/api/**/*.md. Если вы настраиваете другую директорию вывода с помощью параметра outDir ниже, то соответствующие .md-файлы также следует добавить в .gitignore.

Файл _meta.json автоматически генерируется только при первом запуске и в дальнейшем не перезаписывается. Это позволяет вручную редактировать его для настройки структуры боковой панели (например, добавлять разделители, менять порядок и т. д.) и коммитить в git.

Не изменяйте сгенерированные .md файлы в директории api, поскольку они перезаписываются при каждом запуске проекта, чтобы отражать изменения в содержимом модулей.

Опции

entryPoints

Тип: string[]
По умолчанию: []

Указывает абсолютные пути к модулям TypeScript, для которых нужно генерировать документацию.

outDir

Тип: string
По умолчанию: api

Настраивает директорию вывода документации. Укажите относительный путь, например api/custom.

setup

Тип: (app: Application) => Promise<Application> | Promise<void> | void
По умолчанию: () => {}

Функция для настройки приложения TypeDoc. Используется для кастомизации конфигурации TypeDoc перед генерацией документации.

#@rspress/plugin-typedoc Исходный код

#Установка

#Использование

#Опции

#entryPoints

#outDir