问题标签 [docfx]

https://github.com/KevReed/DocFx.Plugins.PlantUml

我已经通过nuget为docfx插件安装了plantUml。通过nuget install DocFx.Plugins.PlantUml -ExcludeVersion -OutputDirectory .命令，在构建docfx之后我得到了这个结果，我检查了本地主机上的index.html，但它没有用。我看不到植物图，只有带框的纯文本。如果您有任何想法，请帮助我。我检查了构建的<code class="lang-plantuml">html 上的标签。

这是我的环境。

[小路]

[docfx.json]

[介绍.md]

[docfx 构建]

DocFX 未正确呈现 VB 代码注释。看起来它认为注释引号是字符串的开头。

我的代码如下所示：

实际行为

docfx 文档站点显示了如何自定义默认模板中使用的各种 .partial 文件（请参阅https://dotnet.github.io/docfx/tutorial/walkthrough/advanced_walkthrough.html）。

我已经按照这些说明创建了一个新的模板文件夹并将修改后的 styles\main.css 文件放入其中，并且还采取了应用模板部分下的步骤，其中除了默认值之外还指定了自定义模板名称：

但是，当我构建站点时，_site/styles/main.css 文件没有我的更改。

我正在使用 DocFX 框架为我的 .NET DLL 生成文档。它提供了很好的定制体验。然而，我只是坚持这样一个事实，即我的公共 VB 事件包含在文档中，但缺少与参数相关的信息。

例如，对于一种方法，文档如下所示：

方法名

一些说明...

宣言

申报资料

参数

列出所有参数的表格，包括类型、名称和描述列

但是，对于带有参数的事件，缺少列出所有参数和信息的表格。

任何解决方案或解决方法将不胜感激。

我们使用 docfx，它作为 nuget 包含在我们的一个 csproj 文件中。我没有亲自设置这个东西，也没有关于它如何工作的更多信息，但它看起来像是一个简单的 nuget 添加到 C# 项目，然后在 Visual Studio 中的项目编译期间生成文档。

我们的问题是构建日志的详细程度总是设置为详细（或详细或他们如何称呼它），即我在解决方案中有 20 个 c# 项目，因为我没有警告或错误，输出窗口中的构建输出是整个解决方案非常短，每个项目只有几行。但是这个带有d​​ocfx的项目在编译期间总是会产生很多输出，因为它将所有详细消息写入输出窗口（以及放置在项目目录中的log.txt文件）。

问题是如何从“输出”窗口中摆脱它。我试图用谷歌搜索它，我发现命令行上的 --logLevel 警告参数可以降低详细程度。但是我们不使用任何命令行，我们在项目中有 nuget。而且我看不到可以指定此 --logLevel 警告的地方。

（使用最新的 nuget "docfx.console" 版本 2.40.4，C# 项目属于类库类型。我在任何地方都看不到特殊设置。对于输出窗口和日志文件，msbuild 详细程度的 Visual Studio 设置都设置为最小。 )

我将 DocFX 添加到 Visual Studio 以为我的 C# 代码生成 Web 文档。但是，对于每次编译，它都会创建需要很长时间的新文档。当我不需要它时，有没有办法在 Visual Studio 中将其关闭？

我知道可以卸载/安装它，但这是最后的手段。

我想为 .NET 项目创建类似于 API 文档网站的东西。根据.NET Docs，我们放在方法、类等之上的 XML 注释可以由编译器处理成 XML 文件，并且该文件可以通过DocFX等工具运行以生成文档网站。.NET Docs 没有为后者提供任何说明，DocFX 文档也没有提供任何关于如何使用该 XML 文件创建 API 文档网站的提示。

关于如何将 XML 文件与 DocFX 一起使用来生成 API 文档网站的任何想法？

我正在从 C# 项目生成 API 参考。该项目是大型解决方案的一部分，并且对程序集和命名空间有很长的命名约定，因此项目中的每个命名空间都类似于 [CompanyName].[System].[Area].[Module].[...]（例如 MyBiz.CRM .Sales.Analytics.Persistence.Common 和 MyBiz.CRM.Sales.Analytics.Persistence.Sql）。由于项目中的所有命名空间都以 MyBiz.CRM.Sales 开头。我分别为每个系统和区域生成参考，我想排除 MyBiz.CRM.Sales。在左侧的目录中，仅在标题/标题中提及。

是否可以在 docFX 中或者我需要编写自定义服务器端构建后事件脚本？

提前致谢

我正在尝试利用 Visual Studio 中的 XML 表示法功能来为我正在编写的 API 构建文档。我遇到了一个问题，我无法弄清楚如何在我的代码示例中引用方法名称而不自动填充参数类型

例子：

这使用 DocX 获得了以下结果：

为什么我不能在不自动显示参数类型的情况下引用方法名称？我是否需要对示例中的方法调用使用字符串文字而不是引用它？

我想知道是否可以在 DocFx 自定义模板预处理器的上下文中进行简单的 API 调用（例如 GitHub API v3）。我一直在尝试各种不同的方法，但到目前为止还没有完全奏效。

我的目标是调用 API 以检索一些数据，然后相应地更新模型以在 *.liquid 或 *.tmpl 渲染器中使用。

我尝试过使用http / https节点模块。我也尝试过使用node-fetch。它会导致一个 docfx 构建错误，例如：

错误：使用“conceptual.html.primary.js”从“.../index.md”生成的转换模型“.../index.raw.json”时出错。在模板预处理器中运行 Transform 函数时出错

根据 DocFx 文档，预处理器遵循 ES 5.1 标准。我的代码符合这一点。

有谁知道这是否可能？

顺便说一句，我能够很好地进行简单的模型操作，所以我理解了这里使用 DocFx 预处理器的基本概念。

谢谢！