npm.io
0.4.1 • Published 20h ago

centora

Licence
GPL-3.0-or-later
Version
0.4.1
Deps
0
Vulns
0
Weekly
0

Centora

Centora est un agrégateur en ligne de commande : il assemble plusieurs collections de slidedecks (fichiers AsciiDoc) et de thèmes CSS, provenant de dépôts locaux ou Git, et génère un site statique de présentations reveal.js prêt à publier. Il sert de brique commune à l'écosystème eTech pour construire un site de présentations à partir de sources multiples sans dupliquer la configuration.

Écrit en TypeScript (ESM, Node.js), avec une architecture hexagonale (voir le guide de contribution).

Installation

Prérequis : Node.js 22 LTS ou supérieur et npm.

Centora n'est pas encore publié sur un registre npm public à ce jour. En attendant, on l'installe en clonant ce dépôt :

git clone https://gitlab.groupeonepoint.com/etech/marketeam/centora.git
cd centora
npm install
npm run build

Une fois la publication npm effective, l'installation se fera simplement via npm install centora (ou npx centora <commande> sans installation locale).

Vous préférez ne pas installer Node.js localement, ou voulez le détail complet des prérequis et des raccourcis npm fournis ? Voir INSTALL.adoc (inclut notamment une alternative via Docker).

Première commande

Après l'installation, vérifiez que le CLI répond :

node dist/cli.js --help

Pour générer votre premier site de présentation en quelques minutes, sans connaissance préalable du projet, suivez le guide de démarrage.

Les 5 commandes

Commande Rôle
retrieve Copie les sources et thèmes déclarés dans playbook.yml vers un cache local
prepare Lit chaque centora.yml et construit un manifeste agrégé
generate Convertit les slidedecks AsciiDoc en HTML reveal.js
public Assemble le dossier public final (HTML, thèmes, reveal.js)
build Enchaîne les quatre étapes précédentes

Documentation complète, options et exemples : voir la référence CLI et le guide d'utilisation du CLI.

Documentation

La documentation complète (tutoriels, guides pratiques, explications, références) est publiée au format Antora dans docs/, organisée selon l'approche Diátaxis. Point d'entrée : docs/modules/ROOT/pages/index.adoc.

Contribuer

Vous voulez ajouter une commande, corriger un bug ou lancer les tests ? Le guide de contribution explique l'architecture hexagonale du projet, comment ajouter une commande CLI, lancer les tests, et les conventions de commits/branches à respecter.

Licence

Centora est distribué sous licence GPL v3.0 ou ultérieure (GPL-3.0-or-later). C'est le seul composant de l'écosystème eTech sous cette licence, en raison de sa vocation à être publié sur un registre npm public.