asciidoctor ghpages action
v2.3.0 :: Support git-lfs repos
Eine Github -Aktion, die Asciidoc -Github -Seiten in Ihrem CI -Workflow erstellt. Es konvertiert rekursiv jede adoc Datei in html und umbenannt die resultierende README.html in index.html und drückt dann alle generierten HTML und vorhandenen Dateien in die gh-pages Zweigstelle. Wenn Sie nichts Besonderes wie Antora brauchen, ist diese Aktion möglicherweise der Weg, um eine einfache Asciidoc -Website zu veröffentlichen. Wenn Sie jedoch eine strukturiertere Website benötigen, ist Jekyll Asciidoc QuickStart möglicherweise genau das Richtige für Sie.
Nach der Konfiguration der Aktion sind Ihre Github-Seiten unter http://your-username.github.io/your-repository verfügbar.
Denken Sie daran, dass jedes Mal, wenn die Aktion ausgeführt wird, der gh-pages -Zweig ausgelöscht wird. Wenn Sie etwas dazu hinzufügen, außerhalb des CI -Workflows, geht der Inhalt verloren. |
Wir probieren unsere eigene Medizin, indem wir dieses Repository auf Github -Seiten veröffentlichen.
Sie müssen die Aktion einfach zu Ihrer YML -Workflow -Datei hinzufügen, und das ist es. Sie können den Build optional anpassen, indem Sie der Aktion zusätzliche Parameter angeben, die dem Asciidoctor -Tool übergeben werden.
Hier können Sie eine vollständige Workflow -Datei überprüfen. Wenn Sie die GitHub -Aktionsschnittstelle nicht verwenden und diese Datei einfach an denselben Ort in Ihrem Repository kopieren möchten, kann dies nicht in der Box gelten.
Wenn Sie den Fehler "Remote: Erlaubnis zu Git an Github-Actions [Bot]" erhalten, zugreifen Sie auf Settings > Actions > General und wählen Sie Read and write permissions .
Mit der Aktion können die automatische Erzeugung einer ebook.pdf -Datei aus den Asciidoc -Dateien aktiviert werden. Der PDF wird auch in den gh-pages -Zweig geschoben. Um dies zu aktivieren, fügen Sie einfach die folgende Konfiguration hinzu:
pdf_build : trueHier ist ein Beispiel für PDF -E -Book erhältlich.
Mit dieser Aktion können Sie auch Asciidoctor enthüllen. Dadurch werden eine Datei Slides.html in die gh-pages Zweigstelle generiert. Sie können die folgende Konfiguration dafür verwenden:
slides_build: boolean - Erstellt eine Slides.html -Datei (Standard False).
slides_main_adoc_file: string - Definiert den Namen der Asciidoc -Quelldatei zum Erstellen der Folien (Standard 'ReadMe'). Fügen Sie die Dateierweiterung nicht hinzu.
slides_skip_asciidoctor_build: boolean - So aktivieren Sie Skippig.
Wenn Sie überprüfen möchten, wie Sie eine Website aus mehreren ASCIIDOC -Dokumenten erstellen, überprüfen Sie dieses Beispiel -Repository. Es ist nur auf Portugiesisch, aber Sie können die Struktur erhalten.
Die Aktion ist einfach, aber um zu zeigen, wie Sie eine Website mit mehreren Seiten aus verschiedenen ASCIIDOC -Dateien erstellen können, werden die Details hier in einer separaten Seite bereitgestellt. Und erkennen Sie, dass der Link oben auf A: (i) adoc -Datei zeigt, wenn Sie diese Seite aus dem GitHub -Repository und (ii) html -Datei beim Öffnen dieser Seite auf den Github -Seiten öffnen.
GitHub-Seiten benötigen eine CNAME Datei auf der gh-pages -Zweigstelle. Aber bei jedem Aktionslauf wird die gh-pages -Zweigstelle ausgelöscht. Um eine benutzerdefinierte Domain funktionieren zu lassen, fügen Sie einfach die CNAME Datei in das Stammverzeichnis Ihres main oder master Zweigs hinzu, und sie wird automatisch in die gh-pages -Zweigstelle kopiert. Wenn Sie eine source_dir konfigurieren lassen, muss sich die CNAME -Datei in Ihrem konfigurierten source_dir befinden.
