构建自定义引导文档

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

我一直在网上寻找，我找不到任何为3.x构建静态文档的人。有没有人做过这件事，或者是解析HTML文件并以适当格式重新创建它们的唯一方法？

来源

2014-05-12 ChimericDream

“因此通过Jekyll提供的文档不是一个可行的选择”嗯？这是一个完全不相关的问题。你为什么排除杰基尔？ – cvrebert

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

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，那么这个过程就更简单了。请参阅@ SeanRyan的回答或GitHub's documentation了解关于在gh-pages上设置Jekyll站点的详细说明。

既然问了这个问题，我已经学到了更多关于自动化构建的一般和Jekyll的具体内容，而且我已经建立了与上述描述非常相似的构建。对于任何人发现这个问题，我想回来总结一下我认为是最好的解决方案。

来源

2016-09-16 13:48:25 ChimericDream

我认为你在浏览Jekyll时太快了一点。我可以看到一个适度无痛的方式来实现这一点。

为您的Bootstrap版本创建一个GitHub回购。
创建一个gh页面分支。
查看工作文档 - 这应该有你定义样式 - 在GHACCOUNT.github.io/REPONAME/docs

GH-页面实际上是如何引导他们提供在线文档。他们只是在其上放置了一个自定义域。

请注意，您必须使用任何不是开箱即用的Bootstrap创建的组件来更新文档，但这只是更新docs文件夹的问题，将更改合并到gh-pages分支，并推到GH。

来源

2014-05-15 13:40:03

我做了一个小的“主题元素”演示给我杰奇引导的主题页面，您可以在这里http://hmfaysal.github.io/hmfaysal-omega-theme/theme-setup/theme-elements/

看到它的主题文件是在这里：http://hmfaysal.github.io/hmfaysal-omega-theme/documentation/

它的工作正在进行中。所以期待一些错别字和错过的元素。就像我期望每个人都已经知道了:)我还没有实例阐述大部分的引导要素

让我知道如果你需要什么

来源

2014-05-18 06:47:35

构建自定义引导文档

回答

相关问题