readme : cleanup typos

.github/workflows/generate-docs-and-publish-with-github-pages.yml

@@ -40,7 +40,9 @@ jobs:
     runs-on: ubuntu-latest
     container: pandoc/core
     steps:
-    
+
+      - uses: actions/checkout@v3
+
       - name: Download `docs` Build Artifact
         uses: actions/download-artifact@v3.0.0
         with:
@@ -48,8 +50,7 @@ jobs:
           path: docs 
           
       - name: Generate docx
-        run: |
-          pandoc --from docbook --to docx --toc --highlight-style tango -o docs/output.docx docs/output.docbook.xml --resource-path=docs
+        run: ./generate-docx.sh
       
       - name: Upload docs-with-docx Build Artifact
         uses: actions/upload-artifact@v3.1.0

.gitlab-ci.yml

@@ -14,7 +14,7 @@ build-pandoc:
     entrypoint: [ "/bin/sh", "-c" ]
   needs:
     - build-adoc
-  script: pandoc --from docbook --to docx --toc --highlight-style tango -o docs/output.docx docs/output.docbook.xml --resource-path=docs
+  script: ./generate-docx.sh
   artifacts:
     untracked: false
     expire_in: 30 days

Makefile

-all: 01-slides 01-pdf 01-epub 01-docbook
-.PHONY: 01-slides
+all: dc-slides dc-pdf dc-epub dc-docbook
 
-01-slides:
-	docker compose run --rm build-slides; rm -rf docs/assets; cp -r 01-slides/assets docs/
-01-pdf:
+dc-slides:
+	docker compose run --rm build-slides; rm -rf docs/assets; cp -r _content/assets docs/
+dc-pdf:
 	docker compose run --rm build-pdf
-01-epub:
+dc-epub:
 	docker compose run --rm build-epub
-01-docbook:
+dc-docbook:
 	docker compose run --rm build-docbook
-01-docx:
-	pandoc --from docbook --to docx --toc --highlight-style tango -o docs/output.docx docs/output.docbook.xml --resource-path=docs
+dc-docx:
+	docker compose run --rm build-docx
 
-ci-01-slides:
-	asciidoctor-revealjs -a revealjsdir=https://cdnjs.cloudflare.com/ajax/libs/reveal.js/3.9.2 01-slides/index.adoc -o docs/index.html; rm -rf docs/assets; cp -r 01-slides/assets docs/
-ci-01-pdf:
-	asciidoctor-pdf 01-slides/index.adoc -o docs/output.pdf
-ci-01-epub:
-	asciidoctor-epub3 01-slides/index.adoc -o docs/output.epub
-ci-01-docbook:
-	asciidoctor -b docbook 01-slides/index.adoc -o docs/output.docbook.xml
-ci-01-docx:
-	pandoc --from docbook --to docx --toc --highlight-style tango -o docs/output.docx docs/output.docbook.xml --resource-path=docs
+all-no-docker: slides pdf epub docbook docx
 
-# Can be launched from docker image : `asciidoctor/docker-asciidoctor`
-ci-adoc: ci-01-slides ci-01-pdf ci-01-epub ci-01-docbook
+slides:
+	asciidoctor-revealjs -a revealjsdir=https://cdnjs.cloudflare.com/ajax/libs/reveal.js/3.9.2 _content/index.adoc -o docs/index.html; rm -rf docs/assets; cp -r _content/assets docs/
+pdf:
+	asciidoctor-pdf _content/index.adoc -o docs/output.pdf
+epub:
+	asciidoctor-epub3 _content/index.adoc -o docs/output.epub
+docbook:
+	asciidoctor -b docbook _content/index.adoc -o docs/output.docbook.xml
+docx:
+	./generate-docx.sh
 
-ci-pandoc: ci-01-docx
+# In CI, all asciidoctor make targets can be launched from the docker image : `asciidoctor/docker-asciidoctor`
+ci-adoc: slides pdf epub docbook
 

README.adoc

@@ -26,7 +26,7 @@ Ce dépôt a été généré à partir du template : https://github.com/baldir-f
 
 == Écrire du contenu
 
-Modifier les fichiers présents dans link:01-slides/[`01-slides`].
+Modifier les fichiers présents dans link:_content/[`_content/`].
 
 Voir la section <<_ressources-asciidoctor-complementaires,Ressources Asciidoctor complémentaires>> pour démarrer avec Asciidoctor et RevealJs.
 
@@ -54,27 +54,27 @@ Optionnel
 
 [source,shell]
 ----
-docker compose run build-slides
+docker compose run --rm build-slides
 # Ou avec GNU Make
-make 01-slides
+make dc-slides
 ----
 
 === Génération du Pdf
 
 [source,shell]
 ----
-docker compose run --rm build-slides; rm -rf docs/assets;cp -r 01-slides/assets docs/
+docker compose run --rm build-slides; rm -rf docs/assets;cp -r _content/assets docs/
 # Ou avec GNU Make
-make 01-pdf
+make dc-pdf
 ----
 
 === Génération de l'E-book
 
 [source,shell]
 ----
-docker compose run build-epub
+docker compose run --rm build-epub
 # Ou avec GNU Make
-make 01-epub
+make dc-epub
 ----
 
 [#_generation_du_docbook]
@@ -82,26 +82,37 @@ make 01-epub
 
 [source,shell]
 ----
-docker compose run build-docbook
+docker compose run --rm build-docbook
 # Ou avec GNU Make
-make 01-docbook
+make dc-docbook
 ----
 
 === Génération docx
 
-Prérequis : avoir pandoc installé (je n'ai pas encore réussi à le faire fonctionner avec docker)
+Prérequis
+
+[WARNING]
+====
+Sur  macOS (M1), l'image Docker n'étant pas optimisée pour `linux/arm64/v8`, Docker requiert au moins 6.5 Go de RAM allouée (et 7.25 Go de RAM pour des performances convenables). Sans cette configuration, la commande échoue avec le message `Killed`.
+
+Il reste préférable de lancer la commande pandoc native qui donne des performances en dessous de la seconde (installation : `brew install pandoc`)
+
+include::readme/docx-docker-macos-m1-benchmark.adoc[]
+====
 
 Après avoir <<_generation_du_docbook,généré le docbook>>
 
 [source,shell]
 ----
-pandoc --from docbook \
-  --to docx \
-  --toc \
-  --highlight-style tango \
-  -o docs/output.docx \
-  --resource-path=docs \
-  docs/output.docbook.xml
+# Avec docker installé
+docker compose run --rm build-docx
+# Ou avec GNU Make
+make dc-docx
+
+# Avec pandoc installé localement (à privilégier sur macOS M1)
+./generate-docx.sh
+# Ou avec GNU Make
+make docx
 ----
 
 {back_to_top}

docker-compose.yml

@@ -11,7 +11,7 @@ services:
       - "asciidoctor-revealjs"
       - "-a"
       - "revealjsdir=https://cdnjs.cloudflare.com/ajax/libs/reveal.js/3.9.2"
-      - "01-slides/index.adoc"
+      - "_content/index.adoc"
       - "-o"
       - "docs/index.html"
 
@@ -21,7 +21,7 @@ services:
       - ./:/documents/
     command:
       - "asciidoctor-pdf"
-      - "01-slides/index.adoc"
+      - "_content/index.adoc"
       - "-o"
       - "docs/output.pdf"
 
@@ -31,7 +31,7 @@ services:
       - ./:/documents/
     command:
       - "asciidoctor-epub3"
-      - "01-slides/index.adoc"
+      - "_content/index.adoc"
       - "-o"
       - "docs/output.epub"
 
@@ -43,6 +43,12 @@ services:
       - "asciidoctor"
       - "-b"
       - "docbook"
-      - "01-slides/index.adoc"
+      - "_content/index.adoc"
       - "-o"
       - "docs/output.docbook.xml"
+
+  build-docx:
+    image: "pandoc/core"
+    volumes:
+      - ./:/data/
+    entrypoint: "./generate-docx.sh"
\ No newline at end of file

docs/index.html

@@ -406,7 +406,7 @@ services:
       - "asciidoctor-revealjs"
       - "-a"
       - "revealjsdir=https://cdnjs.cloudflare.com/ajax/libs/reveal.js/3.9.2"
-      - "01-slides/index.adoc"
+      - "_content/index.adoc"
       - "-o"
       - "docs/index.html"
 
@@ -416,7 +416,7 @@ services:
       - ./:/documents/
     command:
       - "asciidoctor-pdf"
-      - "01-slides/index.adoc"
+      - "_content/index.adoc"
       - "-o"
       - "docs/output.pdf"
 
@@ -426,7 +426,7 @@ services:
       - ./:/documents/
     command:
       - "asciidoctor-epub3"
-      - "01-slides/index.adoc"
+      - "_content/index.adoc"
       - "-o"
       - "docs/output.epub"
 
@@ -438,9 +438,15 @@ services:
       - "asciidoctor"
       - "-b"
       - "docbook"
-      - "01-slides/index.adoc"
+      - "_content/index.adoc"
       - "-o"
-      - "docs/output.docbook.xml"</code></pre></div></div></div></section></section>
+      - "docs/output.docbook.xml"
+
+  build-docx:
+    image: "pandoc/core"
+    volumes:
+      - ./:/data/
+    entrypoint: "./generate-docx.sh"</code></pre></div></div></div></section></section>
 <section id="_slide_2"><h2>Slide 2</h2><div class="slide-content"><aside class="notes"><div class="paragraph"><p>Contenu n&#8217;apparaissant pas dans les slides
 Mais dans les notes de présentation ou dans les pdf, ebook, docbook.</p></div></aside>
 <div class="paragraph"><p>Ce chapitre contient des notes de présentation.</p></div></div></section>

docs/output.docbook.xml

@@ -40,7 +40,7 @@ services:
       - "asciidoctor-revealjs"
       - "-a"
       - "revealjsdir=https://cdnjs.cloudflare.com/ajax/libs/reveal.js/3.9.2"
-      - "01-slides/index.adoc"
+      - "_content/index.adoc"
       - "-o"
       - "docs/index.html"
 
@@ -50,7 +50,7 @@ services:
       - ./:/documents/
     command:
       - "asciidoctor-pdf"
-      - "01-slides/index.adoc"
+      - "_content/index.adoc"
       - "-o"
       - "docs/output.pdf"
 
@@ -60,7 +60,7 @@ services:
       - ./:/documents/
     command:
       - "asciidoctor-epub3"
-      - "01-slides/index.adoc"
+      - "_content/index.adoc"
       - "-o"
       - "docs/output.epub"
 
@@ -72,9 +72,15 @@ services:
       - "asciidoctor"
       - "-b"
       - "docbook"
-      - "01-slides/index.adoc"
+      - "_content/index.adoc"
       - "-o"
-      - "docs/output.docbook.xml"</programlisting>
+      - "docs/output.docbook.xml"
+
+  build-docx:
+    image: "pandoc/core"
+    volumes:
+      - ./:/data/
+    entrypoint: "./generate-docx.sh"</programlisting>
 </section>
 </section>
 <section xml:id="_slide_2">

generate-docx.sh

+#!/bin/sh
+
+OUTPUT_DOCX_FILE="docs/output.docx"
+INPUT_DOCBOOK_FILE="docs/output.docbook.xml"
+
+
+echo "Generating .docx document..."
+echo "- input:  $INPUT_DOCBOOK_FILE"
+echo "- output: $OUTPUT_DOCX_FILE"
+
+pandoc --from docbook --to docx \
+  --toc \
+  --highlight-style tango \
+  -o $OUTPUT_DOCX_FILE \
+  --resource-path=docs \
+  $INPUT_DOCBOOK_FILE
+
+
+echo "End of generation."

readme/docx-docker-macos-m1-benchmark.adoc

+Temps de génération moyen observé avec Docker sur macOS
+
+[horizontal]
+6.5 Go RAM:: 37 sec
+6.75 Go RAM:: 37 sec
+7 Go RAM:: 34 sec
+7.25 Go RAM:: 17 sec
+7.50 Go RAM:: 16 sec
+7.75 Go RAM:: 16 sec
+
+Temps de génération moyen observé avec la commande pandoc installée sur la machine hôte
+
+[horizontal]
+commande `pandoc`:: < 1 sec
\ No newline at end of file