Documinter

Aperçu

Documinter est un éditeur entièrement WYSIWYG pour rédiger de la documentation, disponible à la fois dans le navigateur et désormais en application Windows native, et il exporte un document en un seul fichier HTML autonome, ou en PDF paginé sur le bureau, sans plateforme, sans serveur et sans compte. Le document à l'écran ressemble déjà à celui que vous partagerez, ce qui rend l'édition rapide et directe. Il a commencé avec des blocs de base comme les paragraphes, les titres et les listes, et il couvre aujourd'hui les blocs de code, les tableaux, une compatibilité markdown complète, un format personnalisé que j'appelle Mintdown, et un Classeur pour garder ses documents organisés au même endroit.

Sa raison d'être

Je l'ai construit sur mon temps libre pour faciliter la rédaction de documentation destinée aux personnes non techniques de mon travail. Je voulais quelque chose qu'elles puissent ouvrir dans un navigateur et utiliser sans manuel, tout en produisant un résultat propre et présentable. Il est resté volontairement simple au début, et n'a grandi qu'une fois que d'autres personnes se sont mises à l'utiliser.

Son évolution

1. Il a commencé avec les bases, paragraphes, titres et listes, ce qui suffisait à monter un document simple.
2. Puis des collègues m'ont vu l'utiliser et m'ont demandé quel était cet outil, alors j'ai continué à l'enrichir. Les blocs de code sont arrivés pour les développeurs, les tableaux pour organiser l'information, la prise en charge complète du markdown, et un format personnalisé que j'appelle Mintdown pour ce que le markdown laisse de côté, comme les conteneurs et les couleurs.
3. Une fois que je me suis retrouvé avec une pile de documents créés dans l'application, j'ai voulu les garder en ordre là aussi. J'ai donc réutilisé ce que j'avais appris en construisant Campaigns of the Mist et ajouté le Classeur, un système de fichiers pour sauvegarder, organiser et trier les documents.
4. L'étape la plus récente l'a fait passer en natif. J'ai migré toute l'application vers Tauri, lui donnant un cœur en Rust et une vraie version bureau pour Windows, tandis que la version web reste en ligne. Sur le bureau, le Classeur devient un vrai dossier de fichiers sur votre disque, les documents peuvent s'exporter directement en PDF paginé, et tout fonctionne entièrement hors ligne, sans compte, sans cloud et sans télémétrie.

Sous le capot

Tout se compose à partir d'un système de blocs flexible, tandis que le HTML exporté reste entièrement autonome, si bien qu'un document terminé est un unique fichier qui s'ouvre n'importe où. Les images intégrées sont compressées à l'entrée, pour qu'un document puisse porter des visuels sans que le fichier ne devienne démesuré. Mintdown s'appuie sur le markdown pour ajouter les éléments plus riches, conteneurs, couleurs et plus encore, sans perdre l'esprit du texte brut. La version native conserve ce même frontend React au-dessus d'un cœur en Rust, adossant le Classeur à de vrais fichiers sur le disque et à un index de recherche reconstructible, et elle réutilise même deux de mes propres paquets npm, react-piqua-color et react-pop-a-window, pour son sélecteur de couleurs et ses fenêtres flottantes.

Où il en est

Documinter est en ligne sur le web et existe désormais aussi en application Windows native, et je m'en sers encore dès que j'ai de la documentation à rédiger. Ce qui a débuté comme un petit outil pour résoudre mon propre problème au travail est devenu quelque chose que mes collègues utilisent aussi. C'est ça dont je suis fier, il a grandi parce que les gens l'ont trouvé réellement utile, pas parce que je cherchais à le rendre populaire.