根据 DocFx 中的构建参数禁用目录项

如何解决根据 DocFx 中的构建参数禁用目录项

我正在寻找一种解决方案,在该解决方案中,我可以在构建期间根据某些参数更改 docfx 构建的生成输出。我已经看到 docfx.json 中有一个过滤器属性,我可以在其中过滤掉一些 api 的东西。但我想更改由 toc.yml 文件生成的网站的结构/内容

我希望拥有此功能的原因是我为我们拥有的每个客户生成了特定的文档。根据客户在我们产品上注册功能,必须显示静态文档的某些页面,而某些页面不应可供该客户使用。

解决方法

这可能是一个开始:

文件结构

articles
--topic1.md
--topic2.md
--topic3.md
--topic4.md
customer1
--index.md
--toc.yml
customer2
--index.md
--toc.yml

customer1/toc.yml

 - name: Customer 1 home
   homepage: index.md
 - name: Topic 1
   href: ../articles/topic1.md
 - name: Topic 2
   href: ../articles/topic2.md

customer2/toc.yml

 - name: Customer 2 home
   homepage: index.md
 - name: Topic 1
   href: ../articles/topic1.md
 - name: Topic 2
   href: ../articles/topic2.md
 - name: Topic 3
   href: ../articles/topic1.md
 - name: Topic 4
   href: ../articles/topic2.md

docfx.json

{
  "build": {
    "content": [
      {
        "files": [
          "articles/*.md","customer1/**","customer2/**"
        ]
      }
    ],"dest": "_site"
  }
}

输出站点结构

articles
--topic1.html
--topic2.html
--topic3.html
--topic4.html
customer1
--index.html
--toc.html
customer2
--index.html
--toc.html

结果

site/customer1 是客户 1 的自定义登录页面和目录

site/customer2 是客户 2 的自定义登录页面和目录

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。

相关推荐


Selenium Web驱动程序和Java。元素在(x,y)点处不可单击。其他元素将获得点击?
Python-如何使用点“。” 访问字典成员?
Java 字符串是不可变的。到底是什么意思?
Java中的“ final”关键字如何工作?(我仍然可以修改对象。)
“loop:”在Java代码中。这是什么,为什么要编译?
java.lang.ClassNotFoundException:sun.jdbc.odbc.JdbcOdbcDriver发生异常。为什么?
这是用Java进行XML解析的最佳库。
Java的PriorityQueue的内置迭代器不会以任何特定顺序遍历数据结构。为什么?
如何在Java中聆听按键时移动图像。
Java“Program to an interface”。这是什么意思?
Java在半透明框架/面板/组件上重新绘画。
Java“ Class.forName()”和“ Class.forName()。newInstance()”之间有什么区别?
在此环境中不提供编译器。也许是在JRE而不是JDK上运行?
Java用相同的方法在一个类中实现两个接口。哪种接口方法被覆盖?
Java 什么是Runtime.getRuntime()。totalMemory()和freeMemory()?
java.library.path中的java.lang.UnsatisfiedLinkError否*****。dll
JavaFX“位置是必需的。” 即使在同一包装中
Java 导入两个具有相同名称的类。怎么处理?
Java 是否应该在HttpServletResponse.getOutputStream()/。getWriter()上调用.close()?
Java RegEx元字符(。)和普通点?