🏳️🌈♿️👩🎨🌱 En février, je remets 3% de mes ventes à des organismes qui favorisent la diversité, les arts et l'environnement 🏳️🌈♿️👩🎨🌱
Manuel d'alchimie du code
La fabrique à documents est maintenant libre !
C'est quoi, La fabrique à documents ?
La fabrique à documents est un outil web qui convertit un contenu rédigé en syntaxe Markdown vers différents formats pour la publication ou les réseaux sociaux, tels que des stories, des publications, des reels ou des e-book en format PDF.
Voici une vidéo résumé du projet:
Pourquoi c'est un logiciel libre ?
Jadis (quand il y avait de la neige), j'ai créé un groupe pour tester mon outil La fabrique à documents. Je crois que le format que j'ai proposé n'était pas idéal pour tester ce genre de logiciels.
Alors, j'ai simplement décidé de libérer le code de mon outil en public.
C'est un projet expérimental, en cours de développement, disponible sous licence GNU Affero General Public License (AGPL-3.0). Toute contribution est bienvenue !
Comment j'ai construit la fabrique à documents ?
J'ai utilisé un modèle de développement client et serveur. C'est donc une application en deux parties :
-
un client graphique pour entrer le texte, les images et gérer les options, basé sur Streamlit, dans le langage Python.
-
un backend sous la forme d'un API REST basé sur FastAPI, aussi dans le langage Python.
Le tout peut être utilisé localement sur ton ordinateur avec Docker Desktop (je te montre comment faire).
Si tu es plus avancé, tu peux le déployer sur un serveur de containers Docker tel que Coolify, CapRover ou Dokku, ou un cluster Kubernetes ou OpenShift.
L'interface de l'application
Le premier onglet : Markdown
C'est le point de départ de l'interface.
Ici, les utilisateurs peuvent commencer à créer leur contenu en utilisant la syntaxe Markdown. L'interface présente un grand champ de texte où les utilisateurs peuvent saisir leur contenu. Par défaut, ça affiche un texte de démonstration avec des exemples de formatage Markdown comme des titres, des sous-titres, des paragraphes, du code et même des émojis.
Un bouton "Formater le texte" est disponible, permettant aux utilisateurs de formater automatiquement leur texte Markdown. Cette fonction utilise la bibliothèque mdformat pour appliquer une mise en forme cohérente au texte, y compris la numérotation des sections.
Le deuxième onglet : Aperçu
Cet onglet offre aux utilisateurs une vue en temps réel de leur document formaté. Cet onglet affiche le contenu Markdown saisi dans le premier onglet, mais rendu en HTML.
Cela permet aux utilisateurs de voir immédiatement comment leur document apparaîtra une fois formaté, y compris les titres, les paragraphes, et autres éléments de mise en forme Markdown.
Le troisième onglet : Paramètres
Cet onglet permet aux utilisateurs de configurer divers aspects de leur document. Les utilisateurs peuvent sélectionner un style et un format pour leur document à partir d'options récupérées depuis le backend. Ils peuvent également ajuster des paramètres tels que la couleur des liens, la profondeur de la table des matières, le moteur PDF à utiliser, la taille de la police, les dimensions du papier, les marges, et plus encore.
Cet onglet offre aussi la possibilité de générer le document final. Les utilisateurs peuvent choisir l'extension de sortie (jpg, PDF, ou MP4) et, pour les vidéos, définir les FPS et le temps d'affichage. Une fois les paramètres définis, un bouton "Generate post" permet de créer le document final, qui peut ensuite être téléchargé.
Le quatrième onglet : Images
Il permet aux utilisateurs de gérer les images associées à leurs documents. Les utilisateurs peuvent voir une liste des images déjà téléchargées et en sélectionner une pour la visualiser. Cet onglet offre aussi la possibilité de télécharger de nouvelles images.
Les utilisateurs peuvent sélectionner un ou plusieurs fichiers image (jpg ou jpeg) à télécharger. Une fois le téléchargement effectué, l'application affiche un message de confirmation pour chaque fichier.
Les thèmes de publication
L'application vient par défaut avec mes thèmes que tu pourras (devras) remplacer par les tiens ! Chaque thème vient avec un fichier descriptif en JSON et des fichiers de configuration en LaTeX.
Le fichier descriptif permet de configurer la taille des contenus, les marges, la police d'écriture et la configuration du générateur de fichiers PDF.
Les fichiers de configuration en LaTeX permettent de configurer les sauts de lignes, la justification, la gestion des images et des listes et aussi d'inclure des éléments récurrents que tu souhaites avoir dans chacune de tes publications.
Les liens
La documentation se trouve ici:
https://git.jevalide.ca/partage/fabriquedoc-documentation
Le serveur ici:
https://git.jevalide.ca/partage/fabriquedoc-backend
Et l'interface ici:
