asciidoctor ghpages action
v2.3.0 :: Support git-lfs repos
CIワークフローにAsciidoc Githubページを構築するGithubアクション。すべてのadocファイルをhtmlに再帰的に変換し、結果として生成されたREADME.htmlをindex.htmlに変更し、生成されたすべてのHTMLと既存のファイルをgh-pagesブランチにプッシュします。 Antoraのような派手なものが必要ない場合、このアクションは、単純なAsciidoc Webサイトを公開する方法かもしれません。しかし、より構造化されたWebサイトが必要な場合は、Jekyll Asciidoc QuickStartがあなたのためです。
アクションを構成した後、githubページはhttp://your-username.github.io/your-repositoryで利用可能になります。
アクションが実行されるたびに、 gh-pagesブランチが一掃されることに注意してください。 CIワークフロー以外で、手動で何かを追加すると、コンテンツが失われます。 |
このリポジトリをGitHubページに公開することで、自分の薬を味わいます。
YMLワークフローファイルにアクションを追加するだけです。オプションで、アクションに追加のパラメーターを提供することにより、ビルドをカスタマイズできます。これは、Asciidoctorツールに渡されます。
ここで完全なワークフローファイルを確認できます。 GitHubアクションインターフェイスを使用して、そのファイルをリポジトリ内の同じ場所にコピーしたくない場合は、箱から出して動作する場合があります。
エラー「リモート：git actions [bot]に拒否されたgitの許可」が得られた場合、アクセスSettings > Actions > GeneralとRead and write permissionsを選択します。
このアクションにより、Asciidocファイルからebook.pdfファイルの自動生成を有効にすることができます。 PDFはgh-pagesブランチにもプッシュされます。それを有効にするには、次の構成を追加するだけです。
pdf_build : trueサンプルPDF電子ブックはこちらから入手できます。
また、このアクションでasciidoctor revelied.jsスライドを構築することもできます。これにより、Slides.htmlファイルがgh-pagesブランチに生成されます。次の構成を使用できます。
slides_build: boolean -slides.htmlファイルの構築（デフォルトのfalse）を有効にする
slides_main_adoc_file: string asciidocソースファイルの名前を定義して、スライドを構築します（デフォルト 'readme'）。ファイル拡張子を含めないでください。
slides_skip_asciidoctor_build: boolean sciidoctorコマンドを使用して通常のHTMLファイルのビルドを有効にするために、スライドを生成したい場合（デフォルトのfalse）
複数のASCIIDOCドキュメントからWebサイトを作成する方法を確認する場合は、このサンプルリポジトリを確認してください。ポルトガル語だけですが、構造を取得できます。
アクションは簡単ですが、異なるASCIIDOCファイルから複数のページを持つWebサイトを作成する方法を示すために、詳細は別のページで提供されます。上記のリンクがaを指していることを実現します。（i）Githubリポジトリからこのページを開くときのadocファイル、および（ii）Githubページからこのページを開くときにhtmlファイル。
Githubページにはgh-pagesブランチにCNAMEファイルが必要です。しかし、すべてのアクション実行では、 gh-pagesブランチが一掃されます。カスタムドメインを機能させるには、代わりにmainブランチまたはmasterブランチのルートディレクトリにCNAMEファイルを追加するだけで、 gh-pagesブランチに自動的にコピーされます。 source_dirが構成されている場合、 CNAMEファイルは設定されたsource_dir内にある必要があります。
