使用docfx.json中指定的自定义模板进行构建时,为什么我的自定义模板文件未由docfx应用?

时间:2018-11-15 18:33:37

标签: docfx

docfx文档站点显示了如何自定义默认模板中使用的各种.partial文件(请参见https://dotnet.github.io/docfx/tutorial/walkthrough/advanced_walkthrough.html)。

我已按照这些说明进行操作,创建了一个新的模板文件夹,并在其中放置了一个修改后的styles \ main.css文件,并在应用模板部分下采取了自定义模板的步骤除了默认名称外,还指定了名称:

"template": [
  "default",
  "templates/<name of your your HTML template folder>"
],

但是,当我构建站点时,_site / styles / main.css文件没有更改。

1 个答案:

答案 0 :(得分:0)

我在Windows 10上使用docfx,并且docfx位于C:\ docfx,然后导出默认模板并在同一目录中创建了自定义模板。

我正在构建的项目位于其他位置,位于C:\ source ... \ documentation

导航到C:\ source ... \ documentation后,我正在运行docfx构建,并且我发现为了使自定义模板正常工作,我必须在docfx中包括模板文件夹的完整路径。 json,如

"template": [
  "C:/docfx/_exported_templates/default",
  "C:/docfx/templates/MyCustomTemplate"
],

更新: 如@hcdocs所指出的,如果将自定义“模板”文件夹移至C:\ source ... \ documentation而不是C:\ docfx,则无需使用完整路径。完成此操作后,此配置工作正常:

"template": [
  "default",
  "templates/MyCustomTemplate"
],