DOCFX格式表使用markdown而不更改模板

时间:2016-03-10 12:28:27

标签: markdown docfx

是否可以使用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

的样子

MD-Table

某种预期行为:

Expected

1 个答案:

答案 0 :(得分:4)

我们将扩展默认模板:

创建文件:(Project Folder)\template\styles\main.js

默认的DocFX模板使用Bootstrap和JQuery,因此在main.js中输入以下内容:

$(document).ready(function ()
{
   $("table").addClass("table table-bordered table-striped table-condensed");
})

这使得降价表与Api文档中的相同。 要使用Bootstrap表样式,请参阅http://www.w3schools.com/bootstrap/bootstrap_tables.asp

现在,我们将此模板添加到docfx.json中:
在docfx.json中,将"template": ["default"]替换为"template": ["default", "template"]