Compodoc - включает пример варианта

Question

Может кто-нибудь дать мне пример использования опции --includes с Compodoc. Я хочу включить все документы ts в каталог ClientApp -> app с настройками файлов приложения в следующую структуру:

• ClientApp -> приложение (со всеми файлами TS в этой папке)....
• package.json
• tsconfig.json

Мой файл tsconfig.json имеет следующее:

"compileOnSave": false, "include": ["./ClientApp", "./wwwroot/ts"],

и мой package.json имеет следующее:

"compodoc": "compodoc -p tsconfig.json -w -s -o"

Я не могу найти пример "--include" для подражания.

Заранее благодарим за любую помощь, которую вы можете предоставить.

Answer 1

Ответов тоже не нашел. Разобрался как это реализовать:

В ваш package.json вам нужно добавить--includesфлаг с путем к вашей папке уценки:

      "compodoc": "***your options** => add this => --includes ./src/app/markdown/"

./src/app.markdown должен указывать на вашу папку, в которой хранятся файлы .md. Обязательно добавьте файл summary.json, как описано здесь => https://compodoc.app/guides/tips-and-tricks.html .

Надеюсь, это поможет.