Question

我正在尝试创建一个DocFx模板，使用它对胡子的支持。

我希望能够根据项目根目录中的toc.yml文件，在所有生成的html页面的导航栏中生成网站菜单。

我知道默认模板会这样做。但它显然是通过将toc.yml转换为独立的html文件来实现的，然后在概念html文件中通过javascript解析它以加载菜单。

我希望能够在创建概念性html文件的胡子文件中直接执行此操作。

我创建了这个部分（toc.tmpl.partial），并在概念性胡须文件的相应部分调用它：

<div class="sidenav">
    this is sidenav!
    {{#items}}
        hello!
    {{/items}}
</div>

但遗憾的是，{{items}}标记内的任何内容都未生成。

然而，如果我在toc.tmpl中使用相同的代码，那么一个带有适当hello数量的html文件！生产线。

所以我错过了一些关于DocFx各部分协同工作方式的基本知识。

这是我的简单概念文件生成器：

{{!include(/^styles/.*/)}}
{{!include(/^fonts/.*/)}}
{{!include(favicon.ico)}}
{{!include(logo.svg)}}
{{!include(search-stopwords.json)}}
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
  {{>partials/head}}
  <body data-spy="scroll" data-target="#affix">
        {{>partials/navbar}}
        <div style="position: relative; margin-top: 5px;">
            <div class="toc-column" style="position: fixed;">
                    {{>partials/toc}}
            </div>
            <div style="position: fixed; left: 160px;" data-uid="{{uid}}">
                {{{rawTitle}}}
                {{{conceptual}}}
            </div>
        </div>
        {{^_disableFooter}}
        {{>partials/footer}}
        {{/_disableFooter}}
        {{>partials/scripts}}
  </body>
</html>

Answer 1

总之：items在toc的模型中，而不是在概念模型中。在概念items中你不会得到任何东西。您可以尝试运行docfx --exportRawModel来查看模型的样子。

实际上你需要让TOC的模型在所有其他文件中共享。您可以使用isShared提到的here。将以下代码添加到toc.tmpl.js：

exports.getOptions = function (model) {
    return {
        isShared: true;
    };
}

可在此处找到更多信息：http://dotnet.github.io/docfx/tutorial/intro_template.html

在生成概念性html文件时参考toc.yml

1 个答案: