Outil interne

Report Builder

Un document Markdown, un PDF à la charte Arkeyz. Audits, propositions commerciales, comptes rendus : le texte s'écrit, la mise en page suit.

Source Markdown

Aperçu

Syntaxe

Du Markdown standard, plus quelques conventions propres aux documents Arkeyz. Tout le reste — gras, listes, tableaux, liens — se comporte normalement.

Structure

#
Grande section, numérotée en romain (« I. Branding ») et ouvrant sa propre page.
##
Sous-section, numérotée (« 1. »), avec son filet.
###
Intertitre simple, sans numérotation.
---
Filet de séparation.

En-tête du document

Entre deux lignes ---, tout en haut du fichier.

title
Titre porté par la couverture.
summary
Résumé justifié en bas de couverture.
client · clientRole
Destinataire et sa fonction.
date
Date affichée.
tocTitle · tocLead
Titre et phrase d'introduction de la table des matières.
toc: false
Supprime la table des matières.
theme: light
Ouvre le document en version imprimable.

Encadrés

Syntaxe GitHub. Le ton porte un filet, un pictogramme et un libellé — il survit à une impression en niveaux de gris.

> [!NOTE]
> Une information à ne pas manquer.

[!NOTE] [!TIP] [!IMPORTANT] [!WARNING] [!CAUTION]

Images

Des lignes collées forment une rangée, une ligne vide ouvre la rangée suivante. Quatre de front, puis deux, puis une pleine largeur :

![](a.png)
![](b.png)
![](c.png)
![](d.png)

![](e.png)
![](f.png)

![](g.png)
"contain"
Image contenue au lieu d'être rognée — pour une capture.
"plain"
Ni bordure, ni fond, ni arrondi.
"half" · "third"
Moitié ou tiers de la colonne, image seule uniquement.
![Légende]
Le texte alternatif devient la légende.

Schémas

Un bloc de code mermaid, rendu en SVG avant la mise en pages : le schéma n'est jamais coupé entre deux feuilles. Le texte qui suit le mot mermaid devient la légende.

```mermaid Parcours du visiteur
flowchart LR
  A[Recherche] --> B[Site]
  B --> C{Devis ?}
```

Chemins d'images

Les chemins relatifs partent du dossier du .md. Ils ne fonctionnent donc que via la commande — un navigateur ne peut pas lire un dossier du disque, et l'aperçu ci-dessus n'affichera que des images servies par le site (/images/…).

npm run report -- reports/mon-rapport.md
npm run report -- reports/mon-rapport.md --light