构建自定义Bootstrap文档

Question

我一直致力于定制版本的Twitter Bootstrap作为新大学网站的基础。我们希望为校园开发人员提供公共文档，以便能够看到Bootstrap提供的所有组件，因此通过Jekyll提供文档不是一个可行的选择。我们还希望能够使用我们的自定义构建文档。

我一直在网上寻找，我找不到为3.x建立静态文档的人。有没有人这样做，或者只是简单地解析HTML文件并以适当的格式重新创建它们？

Answer 1

我认为你有点过快地浏览杰基尔。我可以看到一种适度无痛的方式来实现这一目标。

1. 为您的Bootstrap版本创建一个GitHub仓库。

2. 创建一个gh-pages分支。

3. 查看工作文档 - 应该有自定义样式 - GHACCOUNT.github.io/REPONAME/docs

gh-pages实际上是Bootstrap如何为其在线文档提供服务。他们只是在它上面放置了一个自定义域名。

请注意，您必须使用您可能已创建的非开箱即用Bootstrap的任何组件更新文档，但这只是更新docs文件夹，合并更改的问题进入gh-pages分支，然后推进GH。

Answer 2

我为我的Jekyll Bootstrap主题制作了一个小的“主题元素”演示页面，你可以在这里看到http://hmfaysal.github.io/hmfaysal-omega-theme/theme-setup/theme-elements/

主题文档在这里：http://hmfaysal.github.io/hmfaysal-omega-theme/documentation/

它正在进行中。所以期待一些错别字和错过的元素。就像我没有演示大部分引导元素一样，因为我希望每个人都知道它们：）

如果您需要任何内容​​，请告诉我

Answer 3

几年后再回到这个问题，我想分享最适合我们用例的解决方案。

tl; dr ：Jekyll工作正常。您只需针对特定用例进行设置

正如@SeanRyan所说，我太快就解雇了杰基尔。当我发布这个时，我的印象是Jekyll主要是一种在本地快速提供网站服务的方式，而不是生成一个几乎可以推送到任何地方的静态网站。但是，我们没有公共（甚至是私人）GitHub组织或GitHub Enterprise服务器，我可以使用我们的自定义文档推送gh-pages分支。

我们用例的最佳解决方案（我遗憾地从未完成）是将Jekyll构建合并到构建过程的其余部分。我没有单独的gh-pages分支推送到某个地方的GitHub服务器，而是有一个style-guide分支，其中包含了Jekyll网站的文件。我在Grunt构建中设置了任务，它将使用master中的模板和资产编译文档，并在style-guide中自动创建新的提交。我们的想法是，在构建过程中，我们可以自动构建我们的站点和资产，生成文档和样式指南，将静态站点推送到自己的分支，并将编译后的样式指南部署到我们Web服务器上自己的URL。

显然，如果您使用的是GitHub或GitHub Enterprise，那么这个过程就更容易了。有关在gh-pages上设置Jekyll网站的详细说明，请参阅@ SeanRyan的回答或GitHub's documentation。

自从提出这个问题以来，我已经了解了更多关于自动构建和Jekyll的更多内容，并且我已经建立了与我上面描述的非常类似的构建。对于任何发现这个问题的人，我想回过头来总结一下我认为最好的解决方案。