标签: docfx

是否可以使用下的markdown更改表的布局docfx？

例如，由于列之间的间隔，下表的可读性不是很好。事件没有交替的行颜色：

| Property | Description |
|---|---|
| URL | `/api/<version>/auth/login` |
| Method | `post` |
| Success | Http status *200* |
| Failure | Http-status *400/500* |
| Content/Media-Type | `application/json` |
| Authorization | *no* |
| Roles | - |

那就是它的样子doxfx：

某种预期的行为：

标题说明了一切 ...

在Sandcastle帮助文件生成器中，我们将NamespaceDoc类添加到每个名称空间中以创建名称空间文档。

我们如何使用DocFX进行相同的处理？

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

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

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

我有以下文件夹结构：

+Documentation
 |- _site
 |- api
 |- apidoc
 |- articles
 |- images
 |- src    <-- This folder is autogenerated by `docfx init` command as a folders above
  docfx.json
  index.md
  toc.md
+packages
 |- Microsoft.NETCore.Platforms.1.0.1
 |- ... other nuget folders
+src
 |- MyRealProject
   |- assets
   |- bin
   |- Commands
   |- obj
   |- Properties
   |- vendor      <- This folder should be excluded for documentation
   app.config
   MyRealProject.csproj
   MyRealProject.csproj.user
   Program.cs
+test
 |-MyRealProjext.XUnit
   |- bin
   |- obj
   |- Properties
   app.config
.gitattributes …

只是希望更改由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 添加到 Visual Studio 中，为我的 C# 代码生成 Web 文档。然而，每次编译都会创建新文档，这需要很长时间。当我不需要它时，有没有办法在 Visual Studio 中将其关闭？

我知道可以卸载/安装它，但这是最后的手段。

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

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

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

明确地说 - 我不想过滤掉某些类型或成员（如这里所述） - 我想过滤掉所有类型的文档的整个部分。