Skip to content

friedrith/md2tex

Repository files navigation

md2tex

md2tex code by Thibault Friedrich. English translation by Rick Henderson.

NAME

md2tex, convert Markdown into LaTex.

SYNOPSIS

md2tex [options] source.md 
md2tex [options] source.mardown
md2tex [options] source.txt
md2tex --configure-header header.tex
md2tex --configure-footer footer.tex

DESCRIPTION

Il s'agit d'un script permettant de générer du code latex à partir d'une
source formatée à l'aide du langage markdown. Il peut générer juste la
partie décrite par le fichier markdown mais en mode COMPLET, il peut aussi
générer l'ensemble d'un fichier latex compilable. Enfin, il peut aussi
générer le pdf correspondant au latex.

The given input file must be a file whose content is formatted
in markdown. It should be noted that the extension of the source file does not 
change the behavior of the converter.

By default the generated code is displayed on the standard output.

OPTIONS

-a, --author
    définit l'auteur du code latex généré. Cette option n'est utile que si
    le mode COMPLET est activé. Par défaut, le nom de l'auteur est "Unknown
    author".

-c, --complete
	active le mode COMPLET qui génére le code complet d'un fichier latex
	capable de compiler en incorporant le code relatif au fichier d'entrée
	à un fichier latex existant. Le header et le footer de ce fichier
	existant sont disponibles dans ~/.md4tex/header.tex et
	~/.md4tex/footer.tex.

--configure-footer [footer]
    remplace le fichier de footer par défaut par le nouveau fichier donné
    en paramètre. Les prochains appels à md2tex utiliseront le nouveau
    fichier.

--configure-header [header]
    remplace le fichier de header par défaut par le nouveau fichier donné
    en paramètre. Afin de pouvoir ultérieurement changer certaines valeurs
    comme le titre, l'auteur ou la date, les emplacements prévus à cet
    effet dans le nouveau header configuré doivent respectivement comporter
    les chaines '@@@Title@@@', '@@@Author@@@' et '@@@Date@@@'. Les
    prochains appels à md2tex utiliseront le nouveau fichier.

-d, --date
    définit la date du code latex généré. Cette option n'est utile que si
    le mode COMPLET est activé. Par défault, la date est à \today.

--footer [footer]
    définit le fichier source utilisé comme footer pour cet unique appel à
    md2tex.

-h, --help
    displays the help file (the README.md file)

--header [header]
    defines the source file used as the header for the current output file 
     
-o, --output [destintation]
	defines the name of the destination file

-p, --pdf
	active le mode COMPLET et génère le fichier pdf. Attention, si le
	fichier de sortie n'est pas explicité par l'utilisation de l'option -o,
	les fichiers source.tex et source.pdf sont crées où source désigne la
	basename du fichier donné en entrée.

-t, --title
    définit le titre du code latex généré. Cette option n'est utile que si
    le mode COMPLET est activé. Par défaut, le titre est "Unknown title".

UTILISATION

Pour utiliser ce script, il faut impérativement lancer le script
d'installation 'install.sh'. Une fois cela fait, il est possible de créer
un alias dans son fichier de configuration de shell vers le fichier
~/.md2tex/md2tex.py

AUTEUR

Le code de ce script python a été écrit par Thibault Friedrich. En cas de
problème, de questions, de propositions d'améliorations, vous pouvez me
contacter à <thibault.friedrich@gmail.com>

This is a python script written by Thibault Friedrich. In case of problems, questions 
or suggestions for improvement, you can contact him at <thibaut.friedrich@gmail.com>

English translations added by Rick Henderson.

BUGS

There are no known bugs, though certain features of markdown have not been implemented.

About

Python script which generates latex code from markdown formatted text.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published