asciidoctor ghpages action
v2.3.0 :: Support git-lfs repos
Une action GitHub qui construit des pages GitHub Asciidoc dans votre flux de travail CI. Il convertit récursivement chaque fichier adoc en html , renommant README.html résultant en index.html , poussant tous les fichiers HTML et existants générés vers la branche gh-pages . Si vous n'avez besoin de rien de sophistiqué comme Antora, cette action pourrait être la voie à suivre pour publier un simple site Web Asciidoc. Mais si vous avez besoin d'un site Web plus structuré, peut-être que Jekyll Asciidoc Quickstart est pour vous.
Après la configuration de l'action, vos pages GitHub seront disponibles sur http://your-username.github.io/your-repository .
Gardez à l'esprit que chaque fois que l'action est exécutée, la branche gh-pages est anéantie. Si vous y ajoutez manuellement quelque chose, en dehors du flux de travail CI, le contenu sera perdu. |
Nous goûtant notre propre médicament en publiant ce référentiel aux pages GitHub.
Vous devez simplement ajouter l'action à votre fichier de flux de travail YML et c'est tout. Vous pouvez éventuellement personnaliser la version en donnant des paramètres supplémentaires à l'action, qui sera remise à l'outil Asciidoctor.
Vous pouvez vérifier un fichier de workflow complet ici. Si vous ne souhaitez pas utiliser l'interface d'action GitHub et copiez simplement ce fichier au même endroit à l'intérieur de votre référentiel, cela peut fonctionner hors de la boîte.
Si vous obtenez l'erreur "Remote: l'autorisation de Git refusée aux actions github [bot]", Settings > Actions > General et sélectionnez Read and write permissions .
L'action permet d'activer la génération automatique d'un fichier ebook.pdf à partir des fichiers ASCIIDOC. Le PDF est également poussé vers la branche gh-pages . Pour activer cela, ajoutez simplement la configuration suivante:
pdf_build : trueUn exemple de livre électronique PDF est disponible ici.
Vous pouvez également construire des diapositives Asciidoctor Reveal.js avec cette action. Qui générera un fichier Slides.html dans la branche gh-pages . Vous pouvez utiliser la configuration suivante pour cela:
slides_build: boolean - permet de construire un fichier Slides.html (par défaut false)
slides_main_adoc_file: string - Définit le nom du fichier source ASCIIDOC pour créer les diapositives (par défaut «Readme»). N'incluez pas l'extension de fichier.
slides_skip_asciidoctor_build: boolean - Pour activer skippig la construction de fichiers HTML réguliers à l'aide de la commande asciidoctor, si vous souhaitez simplement générer les diapositives (par défaut false)
Si vous souhaitez vérifier comment créer un site Web à partir de plusieurs documents ASCIIDOC, consultez cet exemple de référentiel. Ce n'est qu'en portugais, mais vous pouvez obtenir la structure.
L'action est simple, mais pour montrer comment vous pouvez créer un site Web avec plusieurs pages à partir de différents fichiers ASCIIDOC, les détails sont fournis ici dans une page distincte. Et réalisez le lien ci-dessus pointe vers un fichier adoc : (i) lors de l'ouverture de cette page à partir du référentiel GitHub et (ii) du fichier html lors de l'ouverture de cette page à partir des pages GitHub.
Les pages GitHub ont besoin d'un fichier CNAME sur la branche gh-pages . Mais à chaque course d'action, la branche gh-pages est anéantie. Pour faire fonctionner un domaine personnalisé, ajoutez simplement le fichier CNAME dans le répertoire racine de votre branche main ou master et il sera copié automatiquement sur la branche gh-pages . Si vous avez une source configurée source_dir , le fichier CNAME doit être dans votre source_dir configuré_dir.
