DOCFX 格式化表格使用 markdown 而不改变模板
DOCFX format tables using markdown without changing the template
是否可以在 docfx
下使用降价更改 table 的布局?
例如,下面的 table 由于列之间的间距,可读性不是很好。事件没有交替行颜色:
| 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
中的样子:
某种预期行为:
我们将扩展默认模板:
创建文件:(Project Folder)\template\styles\main.js
默认的 DocFX 模板使用 Bootstrap 和 JQuery,因此在 main.js 中输入以下内容:
$(document).ready(function ()
{
$("table").addClass("table table-bordered table-striped table-condensed");
})
这使得降价 table 与 Api 文档中的降价相同。
要使用 Bootstrap table 样式,请参阅 http://www.w3schools.com/bootstrap/bootstrap_tables.asp
现在,我们将此模板添加到 docfx.json:
在 docfx.json 中,将 "template": ["default"]
替换为 "template": ["default", "template"]
。
是否可以在 docfx
下使用降价更改 table 的布局?
例如,下面的 table 由于列之间的间距,可读性不是很好。事件没有交替行颜色:
| 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
中的样子:
某种预期行为:
我们将扩展默认模板:
创建文件:(Project Folder)\template\styles\main.js
默认的 DocFX 模板使用 Bootstrap 和 JQuery,因此在 main.js 中输入以下内容:
$(document).ready(function ()
{
$("table").addClass("table table-bordered table-striped table-condensed");
})
这使得降价 table 与 Api 文档中的降价相同。 要使用 Bootstrap table 样式,请参阅 http://www.w3schools.com/bootstrap/bootstrap_tables.asp
现在,我们将此模板添加到 docfx.json:
在 docfx.json 中,将 "template": ["default"]
替换为 "template": ["default", "template"]
。