问题标签 [docfx]

我已使用 docfx.console 成功地将 DocFx 与 Visual Studio 项目集成，如此处和此处所述。

在此设置下，项目的构建会触发 DocFx 处理在项目下找到的 docfx.json 和 markdown 文件。我不直接执行docfx.exe。这在 Visual Studio 中手动构建项目和在构建服务器上构建时都有效。

我正在使用默认的 DocFx 模板（我的项目中没有提取的模板）和 docfx.console 2.48.1（截至目前的最新版本）。

我现在正在尝试集成自定义 DocFx 插件和后处理器。我从 Github ( RtfDocumentProcessor & DocFx.Plugin.LastModified ) 中获取了两个示例，并创建了一个新的 .NET Framework 4.7.2 类库，它可以构建。

问题是如何修改 docfx.json 来告诉 DocFx 使用插件和后处理器。以上文章假设docfx.exe是直接运行的，并且还有一个“模板”文件夹，例如：

1. 构建我们的项目。
2. 将输出的 dll 文件复制到：
   • 全局：DocFX.exe下名为Plugins的文件夹
   • 非全局：模板文件夹下名为 Plugins 的文件夹。然后使用参数 -t {template} 运行 DocFX 构建命令。

我尝试将我的类库 DLL 放在许多不同的文件夹中，并尝试修改 docfx.json 中的“模板”和“postProcessors”设置，但在每种情况下，构建都会失败并显示这样的消息（这是在抱怨 DocFx. Plugin.LastModified 后处理器，我尝试通过设置运行它：“postProcessors”：[“ExtractSearchIndex”，“LastModifiedPostProcessor”]）：

警告：[BuildCommand] 无法导入：LastModifiedPostProcessor、System.Composition.Hosting.CompositionFailedException：找不到合同“IPostProcessor“LastModifiedPostProcessor”的导出。

有没有人有关于如何让它与 docfx.console 一起使用的说明？

我一直在使用 DocFX 为 C# 生成代码文档，并且在大多数情况下都取得了很大的成功。这些文章很灵活，我真的很喜欢我可以使用 Markdown 来维护它们，同时让它们与 API 参考并存。我还花时间在 Markdown 中记录演练并构建 CI 管道。

我要解决的问题是我需要想办法让我的代码文档（xml 注释）输出为 markdown 而不是 html，以便它可以由 markdown wiki 解决方案托管，特别是 Azure DevOps（又名 TFS） . Azure DevOps Wiki 似乎也与来自 GitHub 的 gh-pages 非常相似，因此我对可能能够在 Azure DevOps 中工作的类似解决方案感兴趣。DocFX 没有解决这个问题，因为输出是 .html 而不是 markdown。

Microsoft 的所有文档都专注于手工编写文档。我有兴趣根据代码中的 xml 注释生成文档。

我正在尝试为 .net 项目（多层）生成文档。但是我无法在使用docfx 生成的文档中看到参考类信息。

例如：

上面的代码引用了ServiceLayer。使用我调用测试方法。但是文档没有显示，这个类正在使用 ServiceLayer Reference。

并且有什么方法可以在文档中的“//”中显示评论

我有这样的解决方案结构：

我尝试更改 docfx.json 的道具和值

每个项目都有 nugetpackage docfx.console。构建解决方案后，我在每个项目中都有文档。我想将解决方案中项目的所有 xml 文档收集到文件夹 Project.Documentation。请告诉我，这可能与否？如果是，你能帮助我并告诉我我做错了什么以及在哪里做错了吗？

基本上我正在尝试更改左侧导航的宽度（sidetoc）。我的一些命名空间和类型的宽度比 sidetoc 允许的宽，因此换行符换行，我真的想避免这种情况。

有没有办法在不使用js的情况下改变它？

正如您在下面的屏幕截图中看到的那样，Type 列不够宽，因此它的内容被包装了。这看起来很难看。

如何增加列宽？

我正在使用 MathJax 尝试使用 .NET 和 DocFX 呈现方程。

此等式为浏览器中的\right错误提供缺失或无法识别的分隔符。

但是，如果我在https://www.mathjax.org/#demo中运行它，那么它会正确预览。

这是我的脚本：

我有一个包含许多页面的 DocFX 站点。我想通过自定义模板在每个页面的顶部包含标签，并且我希望作者能够在 YAML 前端添加标签，例如：

然后，我希望能够以某种数组的形式访问这些标签，并在生成 HTML 输出时对其进行处理。

我在这里阅读了文档，这表明我可以在schema.json某处添加一个文件，这将自动检测架构中的项目。我无法解决的是如何在生成输出时访问我的模板中的 YAML frontmatter。

如果我需要编写一个自定义 .NET 插件来执行此操作，那么这不是问题，但我相信我应该能够以某种方式访问​​模板中的这些属性。

任何指导都将不胜感激！

我们有一个包含测试引擎的 SDK 项目。它们生活在两个不同的 csproj 下。所以我们SDK.csproj有TestEngine.csproj一个.SDK.csprojProjectReference

我有一个 DocFx 项目设置，分别为这两个构建元数据，docfx.json 元数据如下所示：

通过这种方式，我可以设置 TOC 以将这些文档树放在单独的选项卡下。

但是，我不能使用cref在TestEnginexml 文档中引用来自SDK. 我从 DocFX 构建中收到这样的错误： Warning:[MetadataCommand.ExtractMetadata]Invalid cref value "!:SDK.SDKClass" found in triple-slash-comments for TestEngineClass, ignored.

我可以想象为什么这会失败 - DocFXTestEngine单独生成元数据，因此它不知道SDK类或如何链接到它们。有没有办法可以更改配置，以便我可以在最终网站中将这两个项目分开（在单独的 TOC 下）但仍然链接TestEngine到SDK类？

我正在创建一些包含 LaTeX 样式矩阵表示法的 XML 注释。使用docfx 创建文档时，通常表示矩阵中的新行的\\ 字符被转换为\。

有没有办法防止这种情况发生？

输出：