asciidoctor ghpages action
v2.3.0 :: Support git-lfs repos
Tindakan GitHub yang membangun halaman GitHub asciidoc dalam alur kerja CI Anda. Ini secara rekursif mengonversi setiap file adoc ke html , mengganti nama README.html menjadi index.html kemudian mendorong semua HTML yang dihasilkan dan file yang ada ke cabang gh-pages . Jika Anda tidak memerlukan sesuatu yang mewah seperti Antora, tindakan ini mungkin menjadi cara untuk mempublikasikan situs web ASCIIDOC yang sederhana. Tetapi jika Anda membutuhkan situs web yang lebih terstruktur, mungkin Jekyll Asciidoc QuickStart adalah untuk Anda.
Setelah mengkonfigurasi tindakan, halaman github Anda akan tersedia di http://your-username.github.io/your-repository .
Perlu diingat bahwa setiap kali tindakan dieksekusi, cabang gh-pages dihapus. Jika Anda secara manual menambahkan sesuatu ke dalamnya, di luar alur kerja CI, konten akan hilang. |
Kami merasakan obat kami sendiri dengan menerbitkan repositori ini ke halaman github.
Anda harus menambahkan tindakan ke file alur kerja YML Anda dan hanya itu. Anda secara opsional dapat menyesuaikan build dengan memberikan parameter tambahan untuk tindakan, yang akan diserahkan ke alat asciidoctor.
Anda dapat memeriksa file alur kerja lengkap di sini. Jika Anda tidak ingin menggunakan antarmuka tindakan GitHub dan cukup salin file itu ke tempat yang sama di dalam repositori Anda, itu mungkin berhasil di luar kotak.
Jika Anda mendapatkan kesalahan "Remote: Izin untuk Git ditolak untuk github-actions [bot]", Access Settings > Actions > General dan pilih Read and write permissions .
Tindakan ini memungkinkan memungkinkan pembuatan otomatis file ebook.pdf dari file ASCIIDOC. PDF juga didorong ke cabang gh-pages . Untuk mengaktifkannya, cukup tambahkan konfigurasi berikut:
pdf_build : trueContoh ebook PDF tersedia di sini.
Anda juga dapat membangun asciidoctor ungkap.js slide dengan tindakan ini. Itu akan menghasilkan file slides.html ke dalam cabang gh-pages . Anda dapat menggunakan konfigurasi berikut untuk itu:
slides_build: boolean - memungkinkan membangun file slides.html (default false)
slides_main_adoc_file: string - mendefinisikan nama file sumber asciidoc untuk membangun slide (default 'readme'). Jangan sertakan ekstensi file.
slides_skip_asciidoctor_build: boolean - untuk mengaktifkan skippig build file html biasa menggunakan perintah asciidoctor, jika Anda hanya ingin menghasilkan slide (default false)
Jika Anda ingin memeriksa cara membuat situs web dari beberapa dokumen ASCIIDOC, periksa repositori sampel ini. Ini hanya dalam bahasa Portugis, tetapi Anda bisa mendapatkan strukturnya.
Tindakannya sederhana, tetapi untuk menunjukkan bagaimana Anda dapat membuat situs web dengan beberapa halaman dari berbagai file ASCIIDOC, detailnya disediakan di sini di halaman terpisah. Dan sadari tautan di atas menunjuk ke: (i) file adoc saat membuka halaman ini dari repositori GitHub dan (ii) file html saat membuka halaman ini dari halaman GitHub.
Halaman GitHub memerlukan file CNAME di cabang gh-pages . Tetapi pada setiap tindakan, cabang gh-pages dihapus. Untuk membuat domain khusus berfungsi, cukup tambahkan file CNAME di direktori root dari cabang main atau master Anda sebagai gantinya dan itu akan disalin ke cabang gh-pages secara otomatis. Jika Anda memiliki source_dir yang dikonfigurasi, file CNAME harus ada di dalam source_dir yang dikonfigurasi.
