asciidoctor ghpages action

asciidoctor github頁面動作

GitHub動作，該動作在CI工作流程中構建Asciidoc github頁面。它遞歸地將每個adoc文件轉換為html ，將結果README.html重命名為index.html然後將所有生成的HTML和現有文件推到gh-pages分支。如果您不需要像安托拉（Antora）這樣的幻想，那麼此操作可能是發布一個簡單的Asciidoc網站的方法。但是，如果您需要一個更具結構化的網站，那麼Jekyll Asciidoc Quickstart適合您。

配置操作後，您的github頁面將在http://your-username.github.io/your-repository上找到。

配x	請記住，每次執行操作時， gh-pages分支都會消失。如果您手動添加任何內容，在CI工作流程之外，內容將丟失。

1。現場演示

我們通過將此存儲庫發佈到GitHub頁面來品嚐自己的藥物。

2。配置

您只需要將操作添加到YML工作流文件中，僅此而已。您可以選擇通過為操作提供額外的參數來自定義構建，該參數將交給Asciidoctor工具。

您可以在此處查看完整的工作流文件。如果您不想使用github操作接口，而只需將該文件複製到存儲庫中的同一位置，則可以開箱即用。

2.1。故障排除

如果您獲得錯誤“遠程：拒絕Github-actions [bot]的權限”，請訪問Settings > Actions > General ，然後選擇Read and write permissions 。

2.2。構建電子書

該操作允許從ASCIIDOC文件自動生成ebook.pdf文件。 PDF也被推到gh-pages分支。為此，只需添加以下配置：

 pdf_build : true

可以在此處提供示例PDF電子書。

2.3。 Asciidoctor Reles.js幻燈片

您還可以通過此操作構建Asciidoctor Releve.js滑動。這將生成gh-pages 。您可以對此使用以下配置：

• slides_build: boolean啟用構建slide.html文件（默認為false）

• slides_main_adoc_file: string - 定義assiidoc源文件的名稱以構建幻燈片（默認的'readme'）。不包括文件擴展名。

• slides_skip_asciidoctor_build: boolean如果您只想生成幻燈片（默認為false），請使用asciidoctor命令啟用常規HTML文件的構建

3。其他例子

如果您想檢查如何從多個ASCIIDOC文檔創建網站，請檢查此示例存儲庫。它僅在葡萄牙語中，但是您可以得到結構。

4。動作的工作方式

該操作很簡單，但是要展示如何創建一個來自不同ASCIIDOC文件的多個頁面的網站，請在此處單獨的頁面中提供詳細信息。並實現上面的鏈接指向A：（i）從GitHub存儲庫打開此頁面時的adoc文件，以及（ii）從GitHub頁面打開此頁面時的html文件。

5。常見問題解答

5.1。如何配置自定義域？

GitHub頁面需要在gh-pages上的CNAME文件。但是在每次動作運行中， gh-pages分支都被抹去了。要使自定義域工作，只需在main或master分支的根目錄中添加CNAME文件，它將自動複製到gh-pages分支。如果您配置了source_dir ，則必須在您配置的source_dir內部使用CNAME文件。