DocFx 带有一个父子文档站点和多个独立项目在不同的 repos

如何解决DocFx 带有一个父子文档站点和多个独立项目在不同的 repos

我需要你的指导...

鉴于一个组织可能在各种存储库中拥有多个产品,并且可能有许多文档存储库,如何将所有内容集成到一个“docs.acme.com”站点中?

例如:3 个产品:X、Y 和 Z,Z 有多个回购。每个人都有自己的/docs。

productX.git

  • /src/ sln + *.csproj
  • /docs/*

productY.git

  • /src/ sln + *.csproj
  • /docs/*

productZ.core.git

  • /src/ sln + core.csproj
  • /docs/* productz.wpf.git
  • /src/sln + wpf.csproj
  • /docs/* productz.web.git
  • /src/sln + wpf.csproj
  • /docs/*

一些团队甚至有一个概念性文档存储库。

TeamFoo.git

  • /docs/*

和“父”存储库

docs.acme.git

  • /docs/*

结果(如果我们模仿 docs.microsoft.com):

  • docs.acme.com/
  • docs.acme.com/products/
  • docs.acme.com/products/productX/
  • docs.acme.com/products/productY/
  • docs.acme.com/products/productZ/
  • docs.acme.com/products/productZ/core/
  • docs.acme.com/products/productZ/wpf/
  • docs.acme.com/products/productZ/web/
  • docs.acme.com/teams/foo/
  • docs.acme.com/teams/bar/

这怎么可能?

如果每个 repo/docs 都有自己的 docfx.json,那么每个编译的 _site 都将被视为“父站点”,这是不正确的。

到目前为止,我最接近的是每个子文档都有一个存根 index.md 和 toc.yml 并复制“目标文件夹结构”,并有一个“父构建”,其中包括作为参考子存储并复制它们的相关文件夹。

它有效,但不是一个有效或优雅的解决方案。

要求:

  • 作为“产品”开发人员,当我运行 docfx serve 时,我可以验证文档是否看起来不错。
  • 作为“企业文档”集成商,父文档和子文档是一体的。
  • 作为“贡献者”,当我点击“贡献给这个文档”时,我会得到正确的存储库/文件

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 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元字符(。)和普通点?