问题标签 [docfx]

我尝试开始使用 DocFX，它符合我的要求，但我有一个从长远来看相当麻烦的小问题。

每次我更改项目中的某些内容并启用调试时，DocFX 的 nuget 都会适应新的更改。

这是正确的行为，但我希望能够将其关闭一段时间。不需要很长时间，但是由于频繁的更改，它大大延长了测试任何东西的时间。

我正在查看用户手册： https ://dotnet.github.io/docfx/tutorial/docfx.exe_user_manual.html 我尝试自己做，但除了扔之外我没有找到任何方法从项目中删除。

我正在将 NUnit 文档从他们的 GitHub wiki 移植到 docfx。

我试图了解这是否是预期的行为，或者我可以在我的配置文件中做些什么来防止它。

1. 拉nunit/docs回购
2. cd docs
3. docfx build; docfx serve

实际行为

文章显示为“runn”，因为内容文章标题包含该短语

文章显示为“跑步者”，因为内容文章标题包含该短语

文章未显示为“正在运行”，因为没有内容文章标题包含该词，即使 TOC 项目包含

预期行为

我希望“运行测试”项目至少显示出来——最好还有它下面的内容页面。

如何让这些 TOC 项目出现在搜索中？我是否需要向它们添加内容以便将它们视为页面？

我有一个我在本地开发的docfx 网站。我在我的 docfx.json 文件中添加了一个 pdf 对象，以便提供下载网站 pdf 的链接。我正在使用 wkhtmltopdf 来做同样的事情。它在本地工作正常并创建 pdf 文件，但是当我使用 Azure DevOps 构建管道时，管道代理会引发以下错误：

我的 docfx pdf 版本如下所示：

我的 Azure DevOps Build 任务配置如下所示：

知道如何解决这个问题吗？

对不起，如果这是一个简单的解决方案，我不知道。

假设源文件在这样的目录中......

• Docs/articles/guide-1/article-1.md
• Docs/articles/guide-1/article-2.md
• Docs/articles/guide-1/article-3.md
• Docs/articles/guide-1/article-4.md
• Docs/articles/guide-1/article-5.md
• Docs/articles/guide-1/toc.yml

...和 ​​toc.yml 看起来像这样：

有没有办法看到 article-4.md 和 article-5.md 与 toc.yml 位于同一目录中但未在文件中引用？

我知道识别在 Markdown 文件目录中未引用的图像文件的脚本。我希望用未引用的 Markdown 文件完成大致相同的事情。

如果有人知道如何做到这一点，或者对我可能追求的目标有什么建议，谢谢。

操作系统：Windows

使用的 DocFX 版本：2.56.1.0

使用的模板：default

我正在寻找一种方法来更改显示在目录项旁边的默认图标，该图标是“+”号，一旦展开列表项，就会变成“-”号。我希望它是一个右箭头，它在扩展目录时旋转为向下箭头。我试图修改提到这个东西的docfx.css文件（使用glyphicon-menu-right）：

但图标不会出现在docfx 站点中。我应该怎么做？

尽管阅读了docfx 文档和许多 Github 问题，但我无法让我的 docfx 项目正常工作。

采取的步骤：

1. 初始化根目录docfx init -q
2. 从根目录构建docfx build（没有错误）
3. 服务docfx "/user/docfx_project/docfx.json" --serve

堆栈跟踪：

环境：

• OSX 10.13.6
• 文档 2.56.2.0
• .NET Core SDK (3.1.401)
• Mono JIT 编译器版本 6.10.0.104

项目结构：

docfx.json：

哈尔普。

我有一些 .md 文件很高兴地内置到由docfx 生成的站点的文章中。该站点的登录页面目前为 index.md 文件，为空。我有一个单独的静态 html 页面，其内容由包含一些图形等的 javascript 呈现。我想做的是将此 html 内容呈现为 docfx 站点的登录页面。

我怎么做？

任何帮助深表感谢。谢谢。

我有一个 DocFx 项目文件夹，其中包含托管项目的所有正确文件。在我的笔记本电脑上，我可以使用代码docfx docfx.json --serve在我的 localhost 上完全托管项目。但是在我的电脑上它出错了。

我正在使用 GitHub 同步我的文件，因此文件/文件位置是相同的。最初它在我的电脑上工作，然后它停止了......

我得到的错误是：

[20-10-10 04:54:46.403]错误：System.IO.DirectoryNotFoundException：找不到路径的一部分'C:\Windows\System32\docfx_project\obj.cache\build\4t5lswwe.fue\dynp2fa1。 gsl'。在 System.IO.__Error.WinIOError（Int32 错误代码，字符串可能全路径）

完整的错误图像

当前目录：

PS C:\Users\aiden\Documents\GitHub\TAFE.2020.S2.SMALL.GROUP.PROJECT\docfx_project>

如您所见，我的当前目录是项目目录。但是，错误消息指出它正在尝试从 system32 中提取 docfx 数据文件。它试图提取的文件在我的docfx项目中。

由于它在 system32 中找不到文件，因此出错。

任何人都知道这是如何发生或为什么发生的？

我已经建立了一个 docfx 项目来从 ac# 库项目的源代码生成文档。但是，当我有预处理指令时，它似乎不起作用，例如：

我已经在'docfx.json'文件的元数据属性下添加了TargetFramework，甚至还尝试了DefineConstants，但似乎都没有工作。当我没有指令时它会生成文档，但我的目标是'net48'和'netstandard2.0'，预处理器指令不包括在.net标准中不起作用的功能。

更新 当我使用 **.cs 而不是 **.csproj 时，TargetFramework 似乎被忽略了。不使用项目文件时，仅带有“docfxfix.cs”文件#define NET48似乎是一种解决方法。

当我从普通命令提示符（即 msbuild 不在路径中）运行 docfx 时，我收到错误消息“存在清单文件，但找不到 SDK Resolver DLL 文件的路径。”。即使是为 2017 年安装的最新构建工具也是如此。如果我在启动 VS2019 的开发人员命令提示符后运行它似乎没问题（尽管我有时需要删除“obj”文件夹和“api.yml”文件）。

每当我尝试使用 docfx 构建任何文档时，都会在metadata使用 msbuild 分析 csprojs 代码中的 xml 注释的构建步骤中收到以下错误：

警告：MetadataCommand.ExtractMetadataWorkspace 失败：[失败] Msbuild 在处理文件“C:\temp\docfxtest\docfx_project\src\src.csproj”时失败，并显示消息：无法加载 SDK 解析器。存在清单文件，但找不到 SDK Resolver DLL 文件的路径。清单文件路径“C:\Program Files (x86)\Microsoft Visual Studio\2017\BuildTools\MSBuild\15.0\Bin\SdkResolvers\Microsoft.Build.NuGetSdkResolver\Microsoft.Build.NuGetSdkResolver.xml”。SDK 解析器路径：C:\Program Files (x86)\Microsoft Visual Studio\2017\BuildTools\Common7\IDE\CommonExtensions\Microsoft\NuGet\Microsoft.Build.NuGetSdkResolver.dll C:\temp\docfxtest\docfx_project\src\src .csproj

似乎docfx无法正确解析msbuild。知道如何解决这个问题吗？

我在 Windows 上使用 docfx 版本 2.56.5.0，并且我还安装了 VS Enterprise 2019 (16.8.2) 和 VS Build Tools 2017 (15.9.29)：

更新：

我现在已经完全卸载了 VS 2017 构建工具并使用安装程序修复了 VS 2019 安装。我现在在运行docfx 时遇到不同的错误。似乎它根本找不到 msbuild了。

警告：MetadataCommand.ExtractMetadataWorkspace 失败：[失败] Msbuild 在处理文件“C:\temp\docfxtest\docfx_project\src\src.csproj”时失败，消息为：找不到指定的 SDK 'Microsoft.NET.Sdk' . C:\temp\docfxtest\docfx_project\src\src.csproj

运行msbuild -t:restore,build也显示找不到msbuild

'msbuild' 未被识别为内部或外部命令

目标已安装：

.NET Core 工作负载也是如此：