Можно ли создать одностраничный HTML-документ с проектом TypeDoc для TypeScript? - PullRequest
Новая
       16

Можно ли создать одностраничный HTML-документ с проектом TypeDoc для TypeScript?

1 голос
/ 07 июля 2019

Допустим, в моей библиотеке есть два класса TypeScript с именем SuperBase. Database и Record.

Возможно ли с TypeDoc сгенерировать одну страницу с чем-то вроде очень простого формата ниже. Это не должно быть именно так, просто что-то простое и похожее.

Это должен быть очень простой и минимальный , и только одна страница. Что-то вроде того, что вы написали бы в readme-файле Markdown. Все, что нужно сделать, это просто извлечь эти документы из источников и приклеить их на одну HTML-страницу. Это возможно с TypeDoc или, возможно, с каким-то другим инструментом для TypeScript? 

(header) SuperBase
(text) description of the package taken from package.json or somewhere else

(header) Database
(text) Description of the database taken from class docs

(subheader) connect(url: string)
(text) description of the connect method taken from method docs

(header) Record
(text) Description of the Record taken from class docs

(subheader) validate()
(text) description of the validate method taken from method docs

1 Ответ

1 голос
/ 16 июля 2019

Вы можете использовать typedoc, typedoc-plugin-markdown, showdown и concat-md в одной команде. В результате у вас обоих есть разметка одной страницы и HTML вместе.

(Отказ от ответственности: я разработчик с открытым исходным кодом concat-md и readmeasy)

Как

typedoc-plugin-markdown создает серию файлов Markdown из ваших комментариев TypeDoc, а concat-md создает один файл из нескольких файлов Markdown.

Если вам необходимо дополнительно настроить файл README.md в дополнение к включению созданного файла API Markdown, вы можете использовать шаблон README.hbs или README.njk с readmeasy и включить созданный API Markdown в ваш индивидуальный README.md.

Пример * * тысяча сорок-четырь Одиночная команда Команда ниже создает несколько файлов во временный каталог, объединяет их в README.md файл и удаляет временный каталог. (rimraf модуль используется для удаления, потому что он кросс-ОС совместим) $ npm install -D typedoc typedoc-plugin-markdown concat-md rimraf showdown $ rimraf temp-docs && typedoc --plugin typedoc-plugin-markdown --theme markdown --mode file --out temp-docs && concat-md --toc --decrease-title-levels --dir-name-as-title temp-docs > README.md && showdown makehtml -i README.md -o README.html && rimraf temp-docs Описание Установите необходимые модули: $ npm install -D typedoc typedoc-plugin-markdown concat-md showdown Создание файлов Markdown с использованием комментариев TypeDoc в каталоге temp-docs: $ typedoc --plugin typedoc-plugin-markdown --theme markdown --mode file --out temp-docs Создать из них один README.md файл разметки: (также создает оглавление, добавляет имена каталогов в качестве заголовков и автоматически уменьшает уровни заголовков) $ concat-md --toc --decrease-title-levels --dir-name-as-title temp-docs > README.md Преобразование созданной Markdown в HTML с помощью любого конвертера: (я использовал showdown для этого примера) $ showdown makehtml -i README.md -o README.html

...