@rspress/plugin-api-docgen
Этот плагин автоматически генерирует контент документации API, используя пакеты react-docgen-typescript и documentation.
Установка
Использование
Сначала добавьте следующую конфигурацию:
Затем используйте компонент API для вставки документации API в файл MDX:
Интернационализация
Этот плагин использует API плагинов i18nSource, чтобы добавить следующие переводы:
Вы можете переопределить эти тексты с помощью пользовательской конфигурации i18nSource.
Конфигурация
Плагин принимает объект следующего типа:
appDir
appDir настраивает базовую директорию для парсинга. По умолчанию используется process.cwd().
entries
entries настраивает файлы для парсинга.
- Ключ — это идентификатор, используемый как атрибут
moduleNameкомпонентаAPI. - Значение — относительный путь к парсируемому файлу.
apiParseTool
apiParseTool выбирает парсер. По умолчанию используется react-docgen-typescript:
react-docgen-typescriptиспользуется для сценариев библиотек компонентов. Он парсит пропсы для генерации таблиц.
В этой стандартной форме ButtonProps извлекается в таблицу, а Button используется как заголовок таблицы.
Если вы используете экспорт по умолчанию, в качестве заголовка таблицы используется имя файла.
Обратите внимание, что экспорты, объявленные в других местах, недоступны.
Сгенерированный контент будет выглядеть следующим образом:
Если пропсы используют типы React, добавьте эти типы в tsconfig.json; в противном случае типы в пространстве имён React не смогут быть разрешены.
Лучший подход — импортировать тип напрямую:
documentationиспользуется в сценариях утилитарных библиотек для парсинга аннотаций JSDoc. Вот функцияgreetс аннотациями JSDoc.
Сгенерированный контент будет выглядеть следующим образом:
parseToolOptions
parseToolOptions передает параметры выбранному парсеру. Его тип:
Смотрите ParserOptions и DocumentationArgs для доступных параметров.
Когда парсер — react-docgen-typescript, withDefaultConfig по умолчанию создает экземпляр парсера. Если настроены tsconfigPath или compilerOptions, их можно задать отдельно для каждой entry; withCompilerOptions и withCustomConfig используются для создания экземпляра парсера соответственно. Подробности смотрите в Custom Parsers.

