Я хотел бы понять, есть ли способ включить в документацию API дополнительную документацию, генерируемую dartdoc.
В соответствии с Соглашениями макета пакета в каталоге doc/ есть файл getting_started.md, который отображается следующим образом ...
enchilada/
...
doc/
api/ ***
getting_started.md
Какэтот файл включается в документы к dartdoc и где он отображается в выводе?Я пытался просто добавить свои собственные *.md файлы в каталог doc/, но они, кажется, не привыкли.
Я также читал о Категории в dartdoc документация , которая гласит:
категории : Более подробная информация для каждой категории / темы.Для тем, которые вы хотите задокументировать, укажите файл уценки с помощью markdown: для использования на странице категории.При желании переименуйте категорию из исходного кода в отображаемое имя с помощью «name:».Если в dartdoc_options.yaml не определена соответствующая категория, эти объявленные категории в исходном коде будут невидимы.
Поэтому я попытался сослаться на дополнительные документы в файле dartdoc_options.yaml следующим образом ...
dartdoc:
categories:
"Getting Started":
markdown: doc/getting_started.md
"Search Filters":
markdown: doc/search_filters.md
categoryOrder: ["Getting Started", "Search Filters"]
Но это тоже не дало никаких результатов.
Кто-нибудь знает, как, если возможно, включить дополнительную документацию, и если да, как это сделать?