问题标签 [docfx]

我正在尝试创建一个 DocFx 模板，使用它对小胡子的支持。

我希望能够基于项目根目录中的 toc.yml 文件在所有生成的 html 页面的导航栏中生成站点菜单。

我知道默认模板会这样做。但它显然是通过将 toc.yml 转换为独立的 html 文件来实现的，然后由概念性 html 文件中的 javascript 解析以加载菜单。

我希望能够直接在创建概念性 html 文件的 mustache 文件中执行此操作。

我创建了这个部分（toc.tmpl.partial），并在概念胡子文件的适当部分调用它：

{{!版权 (c) 微软。版权所有。在 MIT 许可下获得许可。有关完整的许可证信息，请参阅项目根目录中的 LICENSE 文件。}}

但是，不幸的是，没有生成 {{items}} 标记内的任何内容。

然而，如果我在 toc.tmpl 中使用相同的代码，一个带有适当数量的 hello! 的 html 文件。生产线。

因此，我缺少有关 DocFx 各个部分协同工作的基本知识。

这是我的简单概念文件生成器：

我在 DocFX 配置中缺少一些东西 - 所以它不会生成正确的文档。

我有以下文件夹结构：

我的docfx.json：

运行该命令会docfx build生成没有错误的文档，但是在导航到http://locahost:8080打开目录列表而不是index.htmlfrom_site文件夹时。我的意思是我看到一个只有文件夹列表的网页：api/apidoc/articles/images/_site/ 等。即使我进入_site文件夹并点击index.html- 它确实打开了docfx生成的页面，但点击了'Api文档' 顶部显示文本：TODO: Add .NET projects to the src folder and run docfx to generate REAL API Documentation!

• 我应该在 docfx.json 中重新配置什么，以便正确读取 /src 文件夹而不是 /Documentation/src 文件夹？
• 这是vendor/从文件夹中排除文件夹的正确方法src/吗？

如何将应用程序洞察最终用户用户分析添加到 DocFx 以跟踪每个文档页面的使用情况？

Application Insights 文档指出您需要在结束标记之前立即插入下面列出的 JavaScript 代码段，但我不确定这在 DocFx 中是否可行或最好的实现方式。

您需要后处理器，还是可以使用自定义模板？

我有一个 .net 标准 2.0 类库。我安装了 VS 2017 和 VS 2017 预览版（适用于 net core 2.0）。

我正在尝试运行 docfx 为我的库生成文档。

我首先遇到了一个问题，我收到以下消息：

c:\docfx\Sdks\Microsoft.NET.Sdk\Sdk\Sdk.props

这似乎是因为当 docfx 运行 MSBuild 时，它找不到 dot net core 2.0 preview SDK。我发现这可以通过创建一个名为 MSBuildDSKsPath 的环境变量并将其设置为适当的值来解决。这让我克服了上述错误，现在我遇到了这个错误：

未找到导入的项目“C:\Program Files (x86)\MSBuild\2.0\Microsoft.Common.props”。

这来自 Sdk.props 文件，因为在该文件中是此引用：

MSBuildExtensionsPath 值是正确的，但似乎 MSBuildToolsVersion 是错误的。它应该是 14 或 15（不确定是哪个，但那些是我安装的）。

我尝试了几件事。我尝试在 docfx.json 文件中设置 MSBuildToolsVersion，还尝试设置 MSBuildToolsVersion 环境变量。都不工作。

关于如何让它运行的任何建议？

我正在将应用程序库从 Java 移植到 C#。在 Java 文档中，有些地方使用自定义文本链接到特定的代码引用。例如：

我尝试在 XML 文档注释中使用类似的方法...

...但是当我以这种方式尝试时，整个链接都会从 Intellisense 和生成的文档中消失。问题是，如何使用 C# 中的 .NET XML 文档注释构建带有自定义文本的类似代码链接？如果没有办法做到这一点，推荐的解决方法是什么？

如果重要的话，我们正在尝试使用DocFx代码生成器。

只是希望更改由 DocFX 生成的页脚版权信息。

这是我所做的：

1. 导出模板：

运行docfx template export default，获取文件夹_exported_templates\default

2. 更改页脚部分：

我更改的文件是.\partials_footer.liquid和.\partials\footer.tmpl.partial

3. 使用更新的模板：

运行docfx -t _exported_templates\default。

4. 再次为网站服务

运行docfx docfx.json --serve。

但是当我刷新文档页面时没有显示更新。还有什么我错过的吗？

我希望使用 DocFx 为我们所有已发布的 API 文档创建一个中央存储库。我有通过我的构建（使用 TFS）自动生成并通过我的版本（使用 Octopus）发布的文档，这对于多个单独的站点来说都很好。但是，我想将它完全拉到一个位置。想法是，通过父站点，您可以过滤任何单个站点中的内容，而无需深入研究它们。您对如何执行此操作有建议吗？

此外，在同一个文档存储库中，我想提供搜索我们投资组合中数百个项目的所有元数据（项目级文档）的能力。这将使我们的 BA、DEV 和 QA 团队更容易访问我们所有系统的功能。我喜欢 DocFx 内置的“过滤”功能，但我想要对所有元数据进行全文搜索。您对此功能也有建议吗？

我们目前正在使用 docfx 为我们的代码生成 html 文档。

我们有额外的 html 文档要链接到包括在内。

到目前为止，我已将它作为资源部分包含在 docfx.json 文件中，并且可以正常工作，但是 docfx 抱怨我指向它的任何链接，因为它不知道它。

在 build 部分下添加 html 文件的工作更少，因为 docfx 不知道该怎么做。

我还尝试创建一个 xrefmap.yml 文件来指向我现有的 html，它似乎不喜欢有本地的相对引用。

我目前正在评估为我们的客户生成 API 文档的替代解决方案。目前我们使用我们自己的自制解决方案，我开始了一些研究。这是我遇到 Microsoft 开发和使用的 DocFX 的时候。

似乎非常有用，除了我看不到任何地方提到包含内联注释的事实，例如以下示例：

要求这样做的原因，特别是对于枚举，这是我们一直在将我们希望在文档中公开可见的评论的方式。

我正在尝试从命令行遵循教程。我已经生成了项目并部署了空白网站，然后在源文件夹中添加了一个 vs2012 项目来维护原始层次结构。我已经编辑了 docfx.json 文件以包含“src/ .csproj”“src/ .cs*”，我假设它是递归搜索的。该项目之前曾被评论为与 SandCastle 一起使用，因此应该有很多可以从中提取或生成元数据的内容。我目前安装了 vs2012 msdn。我的问题是元数据永远不会构建，即使我使用示例种子项目，所有 md 文件都会显示在 webhost 上，但不会显示源文件中的文档。