Nantes Université

Skip to content
Extraits de code Groupes Projets
Valider 1e4332f7 rédigé par Gerson Sunyé's avatar Gerson Sunyé
Parcourir les fichiers

Add lab module and a first lab about Antora

parent 8e5f51bd
Aucune branche associée trouvée
Aucune étiquette associée trouvée
Aucune requête de fusion associée trouvée
Pipeline #92865 réussi
......@@ -10,3 +10,4 @@ asciidoc:
example-caption: true
nav:
- modules/ROOT/nav.adoc
- modules/labs/nav.adoc
* xref:index.adoc[Présentation]
* xref:asciidoc[Asciidoc]
* xref:antora.adoc[Antora]
* xref:plantuml.adoc[PlantUML]
* xref:controller.adoc[Controller]
* xref:sequence.adoc[Séquence]
\ No newline at end of file
= Antora
.Travaux pratiques
* xref:antora.adoc[Premiers pas avec Antora]
* xref:plantuml.adoc[Dessiner des diagrammes avec PlantUML]
* xref:controller.adoc[Controller]
* xref:sequence.adoc[Séquence]
\ No newline at end of file
= Antora
== Installation
Antora s'installe avec NPM, à l'intérieur d'un dossier, comme tout autre paquet JavaScript{nbsp}:
[source,shell]
----
mkdir docs-site && cd docs-site
node -e "fs.writeFileSync('package.json', '{}')"
npm i -D -E antora
----
Pour vérifier que Antora a bien été installé, exécutez la commande suivante{nbsp}:
[source,shell]
----
npx antora -v
----
Si tout s'est bien passé, vous aurez comme réponse une liste des paquets installés:
[source,shell]
----
$ npx antora -v
@antora/cli: 3.1.9
@antora/site-generator: 3.1.9
----
== Un exemple simple
Pour produire un site de documentation, Antora a besoin d'un _playbook_.
Dans le dossier `doc-site`, créez un nouveau fichier nommé `antora-playbook` et remplissez-le avec les informations de configuration listées ci-dessous.
Ce fichier _playbook_ nous permettra de créer un site en utilisant les https://gitlab.com/antora/demo[dépôts] de démonstration de Antora.
[source,yaml]
----
site:
title: Antora Docs
start_page: component-b::index.adoc <1>
content:
sources: <2>
- url: https://gitlab.com/antora/demo/demo-component-a.git
branches: HEAD
- url: https://gitlab.com/antora/demo/demo-component-b.git
branches: [v2.0, v1.0]
start_path: docs
ui: <3>
bundle:
url: https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/HEAD/raw/build/ui-bundle.zip?job=bundle-stable
snapshot: true
----
<1> Une page d'un de composant qui sera utilisée comme page d'accueil de votre site.
<2> La catégorie `sources` contient la liste des emplacements des dépôts git, des modèles de noms de branches et d'autres propriétés de dépôts que Antora utilise lors de l'agrégation du contenu du site.
<3> La catégorie `ui` contient des clés qui spécifient l'emplacement du _bundle_ d'interface utilisateur et la façon dont il doit être traité.
== Exécuter Antora
Dans le terminal, assurez-vous d'être dans le répertoire `doc-site`, puis tapez :
[source,shell]
----
npx antora --fetch antora-playbook.yml
----
Naviguez jusqu'au répertoire `docs-site/build/site` et ouvrez le fichier `index.html` dans votre navigateur pour voir le résultat.
Félicitations, vous avez réussi à créer votre premier site avec Antora.
== Le format Asciidoc
AsciiDoc est le le format des contenus de Antora.
AsciiDoc est idéal pour écrire de la documentation car il est lisible, concis, extensible et facile à apprendre.
.Un peu de lecture:
* [ ] https://docs.antora.org/antora/latest/asciidoc/document-header/[En tête]
* [ ] https://docs.antora.org/antora/latest/asciidoc/section-headings/[Sections]
* [ ] https://docs.antora.org/antora/latest/asciidoc/text-and-punctuation/[Texte et styles]
* [ ] https://docs.antora.org/antora/latest/asciidoc/external-urls/[URLs]
* [ ] https://docs.antora.org/antora/latest/asciidoc/lists/[Listes]
* [ ] https://docs.antora.org/antora/latest/asciidoc/ui-macros/[Macros]
* [ ] https://docs.antora.org/antora/latest/asciidoc/source/[Listings]
* [ ] https://docs.antora.org/antora/latest/asciidoc/admonitions/[Avertissements]
* [ ] https://docs.antora.org/antora/latest/asciidoc/examples/[Examples]
* [ ] https://docs.antora.org/antora/latest/asciidoc/sidebar/[Barre latérale]
¥ [ ] https://docs.antora.org/antora/latest/asciidoc/comments/[Commentaires]
== Travail à faire
. Créez un projet sur GitLab pour la documentation d'un projet. Suivez https://docs.antora.org/antora/latest/organize-content-files/[l'organisation de contenu] proposée par Antora.
. Ajoutez à votre projet une page contenant les éléments Asciidoc suivants:
.. Un en-tête
.. Des titres de section
.. Un listing de code source
.. Une table
.. Un avertissement
. Modifiez ensuite le fichier local `antora-playbook.yml` pour y ajouter votre projet.
. Enfin, générez à nouveau la documentation dans le dossier `doc-site`
\ No newline at end of file
Fichier déplacé
Fichier déplacé
Fichier déplacé
Fichier déplacé
0% Chargement en cours ou .
You are about to add 0 people to the discussion. Proceed with caution.
Veuillez vous inscrire ou vous pour commenter