问题标签 [docfx]

在 DocFX 中，我有一块内容需要放在所有（或大多数）markdown 文件中。有没有办法将另一个md文件的内容合并或拉入当前文件？基本上我试图不重复自己并寻找某种共享机制。

我正在尝试创建docfx项目。源代码托管在 GIT 存储库中的 TFS 服务器上。

一切都很好，除了没有改进此文档链接。

有没有办法让这个链接出现并适用于这样的配置？

有两个职责；在第一个问题之前

我的项目层次结构

我想为每个项目代码记录我使用docfx的文档。第一个问题；我不希望重建建筑代码。前任。

第二个问题；我想要文档结果给我另一条路。前任。

代码

docfx docfx ./docs/docfx.json -o -C:\Users\ahmet\Documentation > not working

和我的 docfx.json配置

谢谢

如果要生成文档不同的输出路径，则解决 2 个问题。

docfx init

_site in place of, output path as C:/Users/AhmetPC/Desktop/SourceCode

或这个 docfx.exe docfx.json -o C:/Users/AhmetPC/Desktop/SourceCode

它为我们创造了这条道路。

标题说明了一切 ...

在 Sandcastle Help File Builder 中，我们将NamespaceDoc类添加到每个命名空间以创建命名空间文档。

我们如何使用 DocFX？

如何将参数传递给包含的文件？

文件包含工作：

但我想传递参数。就像是：

文件 2.md：

In my VS 2017 project I reference docfx.console package and I want it to be used only when certain condition is met. But the package gets used for all builds.

Here is a part of my project. I want docfx.console to be used when configuration is Installer/AnyCPU and VS is building net40 flavor.

Is there a way to use docfx.console in Installer build for net40 only?

I've create a simple console application along with a simple docfx project. When I run the DocFX command to generate the documentation I get the following metadata warning and becuasue the warning leads to the documentation not being generated.

[18-06-05 05:52:41.715]Warning:MetadataCommand.ExtractMetadataWorkspace failed with: [Failure] Msbuild failed when processing the file 'E:\Files\tmp\docx\docfx_project\src\src.csproj' with message: C:\Program Files\dotnet\sdk\2.1.300\Sdks\Microsoft.NET.Sdk\targets\Microsoft.PackageDependencyResolution.targets: (198, 5): Error loading lock file 'E:\Files\tmp\docx\docfx_project\src\obj\project.assets.json' : Object reference not set to an instance of an object.

later in the output you see

[18-06-05 05:52:42.467]Warning:[MetadataCommand.ExtractMetadata]No metadata is generated for src.

Anyone else run into this problem? How can I get metadata to generate?

To recreate the project is pretty simple:

1. goto dotnet cli tools command line
2. docfx init
3. cd src
4. dotnet new console
5. cd ..
6. docfx

I have installed and using the dotnet sdk 2.1.300

我通过nuget包管理器（visual studios 2017 15.7.3）将docfx.console安装到一个测试项目中。我的项目是一个 .net 库，它有一个带有一些 xml 文档的单一类。当我构建项目时，它会创建一个带有 .html 文件但没有文档的 _site 文件。它还生成一个 api、apidoc 和文章文件夹以及一个 docfx.json 文件。

项目抛出警告：无法在 obj/api/ 中找到 toc.yml 或 toc.md。确保该文件包含在配置文件 docfx.json 中！

我在 github 中发现了一些类似的问题，建议将我的 Visual Studio 版本设置为 2015，但是据我所知，此解决方案似乎不适用于 docfx.console。有谁知道我如何能够纠正这个问题？谢谢

我尝试使用DocFX为在三斜杠注释中包含标签的项目生成 API 文档。

包含在 Visual Studio IntelliSense 和SandCastle生成的文档中的内容，但在 DocFX 生成的文档中缺失。

DocFX 是否支持/// <include file='ExtDocs.xml' path='...some xpath...'/>语法？

我正在努力使用本地 TFS 为 DocFX 项目设置持续部署过程。

此处描述了该过程，但是示例演练适用于 VSTS，并且我有本地 TFS（2013 版）。基本思想是在每次签入时构建和部署文档网站。该流程使用的DocFx Build Tasks扩展似乎支持本地 TFS ......我只是看不出如何让它工作！

我有一个包含单个 C# 项目的 VS 解决方案，该项目具有对 docfx.console 版本 2.38.1（最新）的 Nuget 引用。当我在本地 PC 上构建 VS 时，_sites 文件夹会正确填充 HTML。但是，在构建服务器上构建时，构建失败并显示“警告 MSB4078：MSBuild 不支持项目文件“DocFx.csproj”，无法构建。

然后我发现了DocFx Build Tasks扩展，它看起来可以解决我的问题。

我已经下载了 .VSIX，但不知道在哪里以及如何安装它。

如果我直接在构建服务器（或我的本地 PC）上运行它，则会出现错误“此扩展无法安装在任何当前安装的产品上”。出现。这是来自安装日志：

我在 TFS 2013 门户中似乎也没有上传扩展的选项（尽管后来的版本似乎有这个）。

我需要做什么？