構建自定義引導文檔

我一直致力於將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

構建自定義引導文檔

回答

相關問題