问题标签 [docfx]

我正在努力将 GitHub Codespaces 添加到 NUnit 文档存储库以进行文档编辑。我们对 Codespaces 在我们的用例中的潜力感到非常兴奋！

目前的成分

• PR 添加代码空间，里面有我们的配置文件和容器：https ://github.com/nunit/docs/pull/563
• 我们从 Codespaces Dockerfile 中引用的 Dockerfile 的来源：https ://github.com/nunit/docfx-action/blob/master/Dockerfile

再生产

• 打开代码空间
• 打开终端
• cd docs
• docfx build- 按预期成功构建
• docfx serve- 表示它在端口上服务8080，正如预期的那样
• 按照终端的链接，8080在转发选项卡中打开端口

预期行为

在根站点的/_site子目录中查看站点，这是 docfx 提供项目的位置

实际行为

在初始 URL 以及尝试/_site附加时看到 502 bad gateway 错误。

我尝试过的其他事情

• 我已经在我的机器上的 VS Code 中拉出了这个分支并在这个容器中打开它。我能够在转发的8080端口根目录和/_site附加端口上看到该站点按预期服务。

我需要你的指导...

鉴于一个组织可能在不同的存储库中拥有多个产品，并且可能有许多文档存储库，如何将所有内容集成到一个“docs.acme.com”站点中？

例如：3 个产品：X、Y 和 Z，并且 Z 有多个 repos。每个都有自己的 /docs。

产品X.git

• /src/ sln + *.csproj
• /文档/*

产品Y.git

• /src/ sln + *.csproj
• /文档/*

productZ.core.git

• /src/ sln + core.csproj
• /docs/* productz.wpf.git
• /src/ sln + wpf.csproj
• /docs/* productz.web.git
• /src/ sln + wpf.csproj
• /文档/*

一些团队甚至有一个概念文档仓库。

TeamFoo.git

• /文档/*

和“父”回购

docs.acme.git

• /文档/*

结果（如果我们模仿 docs.microsoft.com）：

• docs.acme.com/
• docs.acme.com/products/
• docs.acme.com/products/productX/
• docs.acme.com/products/productY/
• docs.acme.com/products/productZ/
• docs.acme.com/products/productZ/core/
• docs.acme.com/products/productZ/wpf/
• docs.acme.com/products/productZ/web/
• docs.acme.com/teams/foo/
• docs.acme.com/teams/bar/

这怎么可能 ？

如果每个 repo/docs 都有自己的 docfx.json，那么编译的每个 _site 都将被视为“父站点”，这是不正确的。

到目前为止，我最接近的是每个子文档都有一个存根 index.md 和 toc.yml 并复制“目标文件夹结构”，并有一个“父构建”，其中包括作为参考的子存储库和副本他们的相对文件夹。

它可以工作，但不是一个高效也不优雅的解决方案。

要求：

• 作为“产品”开发人员，当我运行 docfx serve 时，我可以验证文档看起来不错。
• 作为“企业文档”集成商，父文档和子文档工作/看起来是一体的。
• 作为“贡献者”，当我点击“贡献给这个文档”时，我会找到正确的仓库/文件

在 C# 中，我(A) -> B在 Type 上定义了一个隐式转换运算符A。

使用 DocFx 创建文档时，转换运算符仅出现在 typeA中，而不出现在 type 中B。

作为一种解决方法，我尝试在类型 B 上定义相同的转换运算符，但这会导致“不明确的运算符定义”错误。

我相信文档应该列出两种类型的转换运算符，A并且B. 有没有办法让 DocFx 做到这一点，或者我错过了什么？

我有使用 C#、Nunit 和Visual Studio CODE的 selenium 自动化套件

我已经在 .csproj 文件中添加了这个..

DocFx.json

任何帮助，将不胜感激。

如何配置 VS Code 来调试 DocFx 中的 *.extension.js 前处理器和后处理器脚本？

我本来希望在自定义模板教程中找到一些指导，但没有。

我正在寻找一种解决方案，在该解决方案中，我可以在构建期间根据一些参数更改生成的 docfx 构建输出。我已经看到docfx.json 中有一个过滤器属性，我可以在其中过滤掉一些api 的东西。但我想更改从 toc.yml 文件生成的网站的结构/内容。

我想要这个功能的原因是我为我们拥有的每个客户生成特定的文档。根据客户在我们产品上注册的功能，必须显示静态文档的某些页面，而某些页面不应该可供该客户使用。

我正在为 ac# 项目生成文档，我有一系列想要记录的 MediatR 命令和查询。

我的命令和查询实现MediatR.IRequest了，它们是我doctest.Application项目中唯一要为其生成文档的项目。

我不想为包括MediatR.IRequestHandler类在内的任何其他内容生成文档。

我应该在我的 filterConfig.yml 文件中添加什么来实现这个？

谢谢

这个问题和这个问题一样。但是OP回答了他自己的问题，但对我没有帮助。

我正在尝试创建类似于 Docfx 站点的文档：

但是，当我构建项目时，我得到的 index.html 如下所示：

我的配置是这样的：

• 在 Visual Studio 2017 中为项目安装了 docfx.console 作为 nuget 包。
• docfx 的版本是 2.58.0。
• 我正在 Visual Studio 中构建项目，它会生成 docfx 输出。

我的文件夹配置是：

我可以看到所有文件都在生成，但是目录没有放到 index.html 中。Docfx教程不是很有帮助，因为它还没有升级到最新版本。例如，docfx init不运行，我必须使用docfx new conceptual. 我努力了：

• docfx new conceptual从与 docfx.json 相同的目录中的命令提示符运行
• docfx build从与 docfx.json 相同的目录中的命令提示符运行
• docfx serve _site --port 8182从同一目录运行。但是，完成此操作后，我的浏览器会告诉我检查代理设置。

在我尝试做的所有事情中，我可能已经在一个地方升级了我的 docfx 版本，但不是在 Visual Studio 中，因为运行时docfx serve我得到以下内容根路径： 但我不确定如何恢复或是否需要。

我肯定处于一个锁定的安全环境中，我怀疑这与它有关。有谁知道我可以更改哪些文件（如果有）以使目录与 index.html 位于同一页面上？如果需要的话，如果我只需要在配置文件中执行一次，我不介意手动编写。

我希望 DocFx 保留或转义标签，例如生成<的>html 文件的内容。

目前，DocFx在生成的 html 文件内容中分别转换<和>转换。<>

我正在寻找一种通过使用 php 标签将动态数据传递给 html 文档的方法，<?php以便我将 Web 服务器配置为将.html目录中的文件传递给PHP处理器。

但是，当我包含<?php在文档中时，构建会在内容中创建，<?php这不会导致 PHP 代码被执行。

如果有办法让 DocFx 在概念文档或使用markdown转义某些标签，请提供帮助。

提前致谢。

我多次尝试使用 DocFx 构建文档站点。每次我运行docfx metadataanddocfx build时，该过程都会运行而没有任何错误，但 DocFx 只列出了我项目的几个类型和成员。

我尝试了几个 DocFx 版本；目前我正在使用版本2.58.9.0。

文件结构：

我已经尝试过使用"**.cs"而不是"**.csproj"，结果相同。

我的docfx.json：

文档/api 页面如下所示：

但是我的项目解决方案包含更多的类型和成员，其中很多包括 XML 注释；查看解决方案文件、类的屏幕截图。

我的项目设置如下：

当我将框架更改为 .NET Core 3.0 时，对于 DocFx 文档中显示的文件，我会收到以下警告 - 但奇怪的是，我没有收到解决方案中其他文件的警告：