我想知道是否有一种方法可以在dartdoc生成的API文档中包含其他文档。
根据Package layout conventions，doc/目录中包含一个getting_started.md文件，并显示为如下所示.
enchilada/
...
doc/
api/ ***
getting_started.md字符串
这个文件是如何被dartdoc合并到文档中的，它在输出中显示在哪里？我试着简单地将我自己的*.md文件添加到doc/目录中，但它们似乎没有被使用。
我还在dartdoc documentation中读到了Categories，其中指出：
类别：每个类别/主题的详细信息。对于要记录的主题，请使用markdown：指定用于类别页面的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"]型
但这也没有产生任何结果。
有没有人知道如何，如果它是可能的，包括额外的文件，如果是这样，如何实现这一点？
2条答案
按热度按时间juzqafwq1#
我不同意-arbitary.md是很好的照顾，我使用一个md文件作为顶级解释每一个库，我需要的文件。
但也有一些“陷阱”，正如其他人指出的那样：
1.你的方法/函数文档字符串应该包括一个@category语句，用于你想要的主题类别。
1.你的选项.yaml应该包括类别，和他们的顺序
1.你需要 both 文档字符串中的类别和.yaml中的匹配引用，否则其中一个将被忽略
1.你需要一个匹配的.md文件（我把我的放在docs文件夹中）
然后你会在yaml中看到这样的东西：
字符串
你的方法/函数会有这样的docstring：
型
别忘了创建.md文件。
lymnna712#
Dartdoc不允许在API文档中包含任意.md文件。您可以在README.md或其他文档中创建指向它们的链接，例如通过GitHub或其他提供它们的网址。
例如，dartdoc包为“贡献”文档执行此操作，并显示在API文档中，如下所示：https://pub.dev/documentation/dartdoc/3.0.0/index.html
只有当源代码中至少有一个元素被声明为类别的成员时，类别才会呈现，因此该特性不太适合此用例。