Génération de livres, documentation ou ebook à partir de fichiers Markdown listés dans un fichier d'input (files.txt) et de Pandoc. Les paramètres sont facilement éditables pour faciliter la configuration.
- Pandoc doit être installé et déclaré dans le PATH.
- LaTeX doit être installé.
- Le template Eisvogel doit être installé.
- [optionnel] Support Mermaid : au besoin, installer le filtre Pandoc
mermaid-filteravec la commandenpm install --global mermaid-filter. Enfin, dansconfig.ini: activer le support Mermaid en basculantMERMAID_SUPPORTàTrue.
- Téléchargez et dézippez l'archive
pyBookFromMd.zipdans le répertoire de votre choix. - Dans l'idéal, préfixez les fichiers *.md correspondants aux chapitres dans l'ordre de lecture :
01-lorem,02-ipsum, etc. et déposez dans le même répertoire que l'exécutablepyBookFromMd.exe. - En bash, faites un
ls *.md > files.txtpour générer le fichier d'entrée. - Dans le fichier
config.ini, modifiez les paramètres de génération pour personnaliser le rendu. - Si le document contient différentes parties principales, intégrer les balises TEX
\part{Première partie : Lorem Ipsum}en début de fichier*.mdde nouvelle partie. - Assurez-vous que les fichiers
config.ini,files.txtet éventuellement votre illustration de couverture (ou à défauttitle-background.png) soient bien présents dans le même répertoire que votre exécutable. - Éxecutez
pyBookFromMd.exe. - Ouvrez le PDF généré.
- Clonez le dépôt ou téléchargez l'archive contenant les sources et dézippez dans le répertoire de votre choix.
- Dans l'idéal, préfixez les fichiers *.md correspondants aux chapitres dans l'ordre de lecture :
01-lorem,02-ipsum, etc. et déposez les dans le même répertoire que les fichiers*.py. - En bash, faites un
ls *.md > files.txtpour générer le fichier d'entrée. - Dans le fichier
config.ini, modifiez les paramètres de génération pour personnaliser le rendu. - Si le document contient différentes parties principales, intégrer les balises TEX
\part{Première partie : Lorem Ipsum}en début de fichier*.mdde nouvelle partie. - Lancez main.py avec la commande
python -m main.py. - Ouvrez le PDF généré.
v1.3.0: Passage des paramètres via fichier .INI pour packaging de la solution. Suppression desettings.py.v1.2.0: Ajout du support de Mermaid avecmermaid-filter.v1.1.0: Ajoute le support des Headers et Footers personnalisés. Légère refactorisation : séparation en plusieurs fichiers- main.py : fichier principal à executer.
- function.py : définition des fonctions aditionnelles comme la lecture du fichier d'entrées et la fabriction de la ligne de commande de Pandoc.
- settings.py : fichier de paramétrage. A modifier pour personnaliser le rendu.
v1.0.0: Publication initiale en ligne de commande. Paramétrage depuis les constantes dansmain.py. Utilisation d'un fichier d'entréefiles.txt.
- Transformer
settings.pyen fichier de paramétrage externe en vue de distribuer un package*.exe. - Évaluation l'intérêt de pypandoc pour le projet. Pour référence. Non pertinent.
- Dockerisation avec tout les pré requis pour accès externe. Pour référence.