Zensical est un outil conçu pour générer et maintenir de la documentation de manière simple, automatisée et élégante. Son objectif est clair : réduire la distance entre le code et sa compréhension.

Traditionnellement, la documentation souffre de trois maladies :

• elle est oubliée,
• elle devient obsolète,
• elle est pénible à écrire.

Zensical répond à ces trois problèmes en adoptant une approche moderne :

• génération automatique,
• intégration avec les projets existants,
• écriture en Markdown simple,
• publication fluide.

Le développeur n’a plus besoin de quitter son flux de création. La documentation devient une extension naturelle du projet.

Une architecture simple et moderne

Zensical repose sur quelques principes fondamentaux.

Le Markdown comme langage universel

Le Markdown est lisible par l’humain et interprétable par la machine.

Utilisation

Une génération automatique

Une fois configuré, Zensical peut générer :

• un site de documentation complet
• une navigation automatique
• une structure cohérente
• une mise en page professionnelle

Sans effort supplémentaire.

Une synchronisation avec le code

Zensical peut analyser :

• les fichiers du projet
• la structure des dossiers
• les commentaires du code

Et les transformer en documentation.

Installation

L’installation est généralement simple, souvent via un gestionnaire de paquets.

Exemple sous Linux :

$ python3 -m venv .venv
$ source .venv/bin/activate
$ pip install zensical

Puis initialisation :

$ zensical new projet

Cela crée une structure :

projet
  |-.github
  |-docs/
     |- config.yml
     |-index.md

Génération de la documentation

Une simple commande suffit :

$ zensical build

Ou pour un serveur local :

$ zensical serve

Le résultat est immédiat via http://localhost:8000

• un site web
• navigable
• lisible
• prêt à être publié

Exemple de structure recommandée

mon-projet/
│
├── docs/
│   ├── index.md
│   ├── installation.md
│   ├── utilisation.md
│   └── api.md
│
├── src/
│
└── zensical.yml

Liens

https://zensical.org/docs/get-started/