7

我想了解是否有办法在由dartdoc.

根据包布局约定，目录中包含一个getting_started.md文件doc/，并显示如下...

enchilada/
  ...
  doc/
    api/ ***
    getting_started.md

该文件如何通过dartdoc以及它在输出中的什么位置合并到文档中？我试图简单地*.md在目录中添加我自己的文件，doc/但它们似乎没有被使用。

我还阅读了 dartdoc文档中的类别，其中指出：

类别：每个类别/主题的更多详细信息。对于您要记录的主题，请使用 markdown: 指定降价文件以用于类别页面。或者，将源代码中的类别重命名为带有“名称：”的显示名称。如果 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"]

但这也没有产生任何结果。

有谁知道是否可以包含其他文档，如果可以，如何实现？

4

1 回答 1

1

Dartdoc 不允许在 API 文档中包含任意 .md 文件。您可以在 README.md 或其他文档中创建指向它们的链接，例如通过 GitHub 或其他为它们提供服务的网址。

例如，dartdoc 包为“贡献”文档执行此操作，它显示在 API 文档中，此处：https ://pub.dev/documentation/dartdoc/3.0.0/index.html

仅当源代码中的至少一个元素被声明为该类别的成员时，类别才会呈现，因此该功能不太适合此用例。

于 2021-09-13T20:05:15.713 回答