问题标签 [docfx]

我试图构建一个基于 mono 的 docker 镜像来提供一个 docfx 文档。

这是我的 dockerfile 代码：

entrypoint.sh 是：

构建完成并成功： docker build -t docfxtest 。

当我运行图像时，我得到以下信息：

集装箱停了下来。

我已经在 docker for windows 上对其进行了测试。由于我还是 docker 的新手，我可能错过了一些东西。有人可以帮我理解这个问题吗？

我构建的 docker 映像在那里可用：docker push shoattraceparts/docfxtest:latest

谢谢，

我的项目中有一些事件处理程序委托，我想将它们包含到我使用docfx 自动生成的文档中。

我知道在docfx.json > 元数据中有一个过滤器选项，但是我该如何配置呢？有任何想法吗？

我尝试添加一个filterConfig.yml，并修改docfx.json，没有任何错误，但这不起作用。

C#代码：

docfx.json：

filterConfig.yml：

我在尝试从 Azure DevOps 构建任务生成 DocFX 文档时收到这些警告（它在本地运行良好）：

错误来自dotnet build命令（调用该命令时 DocFX 会生成文档）。

这是我使用的 csproj 文件：

我做错了什么还是 DocFX 问题？

如果需要，这是我的代码分支：https ://github.com/softframe/railsharp/tree/feature/docs

当我运行docfx docfx.json --serve并转到 时localhost:8080，我在顶部菜单上看到两个项目：“文章”和“Api 文档”。当我在文件系统中导航到_site\并单击index.html以在 Chrome 中打开它时，这些菜单项丢失了。当我将其作为静态站点运行时，如何确保正确设置菜单？

我需要能够打包 html 文件并将它们发送给人们以便他们在本地查看，而无需他们下载 repo 并安装 docFX。

我一直在使用 Docfx 生成文档，一切正常。Docfx.html按预期生成文件。

但是，由于html文件嵌入在php文件中，我正在寻找一种将文件生成为.php文件的方法，而不是.html我找不到任何信息的方法。

我需要这个功能，因为我在我的应用程序中使用了 PHP 模板引擎，并且我想在 Markdown 文件中插入模板变量，以便 PHP 在浏览器中加载时解析动态值。

如果这是可能的，我想要一个关于如何做到这一点的指南。例如，如果我可以在创建文件的源代码中找到并修改文件扩展名。

提前致谢。

我正在使用 DocFx 生成有关 WCF Web 服务的文档。文档的目标受众是 Web 服务的客户。这些客户端显然无法直接访问 .NET 二进制文件。

公共接口和模型以及它们的方法和属性的文档很重要，但是还有很多与客户端无关的其他信息：

• 工具
• 继承成员
• 集会
• 句法
• 构造函数

要清楚 - 我不想过滤掉某些类型或成员（如此处所述） - 我想过滤掉所有类型的文档的整个部分。

我们正在开发一个多项目 *.sln 解决方案，并且可以在单独的 Asp.Net Web csproj 中使用 DocFx 成功生成带有 *.md 文章的 API 文档，仅用于文档。

但是我们想在单个 *.csproj 项目中维护和引用本地 Markdown *.md 文章和图像，并在全局文档站点中引用和重用它们，但不知何故我们只能从 /articles 文件夹中获取 *.md 文件在 Web.csproj 中。

这是当前的docfx.json。如您所见，我们正在尝试引用来自不同项目的图像和降价文件

“../Generator/MyDocService.Contracts/**.png”，以及

"../Generator/MyDocService.Contracts/*.md",

但它们都没有出现在我们的“obj”或“_site”文件夹中。

我正在使用 docfx 为库创建文档。我已将 docfx 作为 Visual Studio 的 NuGet 包安装，我想从我的解决方案创建 PDF 文档。每次我构建项目时，docfx 都会抛出一个错误，指出

wkhtmltopdf 是生成 PDF 时的先决条件。请先从https://wkhtmltopdf.org/downloads.html安装它，然后将可执行文件夹保存到 %PATH%。或者，您可以从https://chocolatey.org使用choco install wkhtmltopdf.

我已下载 wkhtmltopdf 并将其添加到 PATH。

我将 JSON 文件配置为创建 PDF 文档，并toc.yml在名为pdf.

JSON文件：

toc.yml文件：

我的图书馆解决方案文件夹结构：

我希望在构建解决方案时创建一个 _site_pdf 文件夹，但我收到一条错误消息，指出 wkhtmltopdf 丢失，即使它已安装并添加到路径中。我怀疑问题出在我的 toc 或 JSON 文件上，但我对这两种文件的经验都很少，所以我找不到问题所在。

我正在尝试使用 DocFx 生成 API 文档。我的印象是，如果我将docfx.consolenuget 包添加到我的 .NET 项目并构建它，文档将自动生成。但这似乎并没有发生。它确实会在文件夹中生成一些 html 文件_sites，但不会将我的 XML 注释转换为友好的 doc 格式。我究竟做错了什么？我的项目是带有 C# (.NET 4.6.1) 的 ASP.NET MVC。

如何让docfx用俄语搜索？它可以很好地搜索英语单词，但不能搜索俄语单词。我尝试调试它，可以看到它使用lunr库进行搜索。如何在docfx中用俄罗斯lunr替换标准lunr库？