markdown2Mathjax

markdown2Mathjax est un paquet simple qui vous permet d'utiliser les mathématiques de style de latex généré par MathJax en collaboration avec le format Markdown populaire. & Nbsp; Il ya deux implémentations de démarque en python, ce forfait est conçu pour être utilisé avec le plus largement utilisé et maintenu activement des deux, appelé markdown2. L'usage typique est comme suit:
#! / Usr / bin / env python
de markdown2Mathjax sanitizeInput d'importation, reconstructMath
de démarques d'importation markdown2
tmp = sanitizeInput (sometxt)
markdedDownText = démarque (tmp [0])
finalOutput = reconstructMath (markedDownText, tmp [1])
(Où «sometxt" est une chaîne contenant le démarque + MathJax texte.)
Installation
markdown2Mathjax est hébergé sur pypi, donc peut être installé à partir des sources, en utilisant:
markdown2Mathjax-x.x.x.tar.gz tar
cd markdown2Mathjax-x.x.x
python setup.py install
ou en utilisant pip (ou easy_install si vous préférez):
pip installer markdown2Mathjax
Utilisation
Par défaut, les mathématiques est marqué par des signes de $ simples pour les mathématiques en ligne et les signes de $$ doubles pour les équations. Cependant, toutes les chaînes de délimitation peuvent être utilisés en changeant les arguments de mots clés pour les fonctions sanitizeInput et reconstructMath. Notez que par défaut MathJax ne utilise dollars simples signes de délimiter maths en ligne, donc si vous utilisez les valeurs par défaut pour ce package, vous devrez indiquer MathJax pour traiter de façon appropriée.
Explication
La fonction sanitizeInput trouve des cas de mathématiques (tel que déterminé par les séparateurs fournis) et les remplace par un espace réservé. Cet espace réservé peut être spécifié par l'utilisateur, mais il est recommandé d'utiliser la valeur par défaut fourni de «$ 0 $». L'espace réservé doit être quelque chose qui ne sera pas traité par Markdown, et ne sera jamais produite par Markdown. La première de ces exigences est assez facile de rencontrer, le second peut être un peu plus subtile. Si l'espace réservé existe déjà dans le texte fourni par l'utilisateur, il est noté par sanitizeInput et sera laissé seul lorsque la reconstruction après le traitement mathématique de démarque.
Chaque fois qu'un bloc de mathématiques valide est rencontré et remplacée par un espace réservé, le calcul est enregistré dans une liste (appelés codeblocks) qui est ensuite retourné par la fonction sanitizeInput. Chaque entrée dans codeblocks est préfixé avec soit 0 (pour une occurrence littérale de l'espace réservé dans le texte), un 1 pour les mathématiques en ligne ou d'un 2 pour une équation distincte.
La chaîne aseptisée sanitizeInput peut alors être marquée par démarque sans crainte de vos calculs étant mutilé. Enfin, reconstructMath remplace chacun des espaces réservés dans le texte marqué avec le bloc de code approprié. Ce html final peut ensuite être affichée avec MathJax appropriée javascript têtes.
Une autre façon de penser à ce sujet est que reconstructMath est fondamentalement l'inverse de sanitizeInput. Donc, sans l'aide démarque entre les deux, rien ne devrait changer entre les deux (sauf lorsque reconstructMath fait aussi peu de nettoyage supplémentaire des codeblocks mathématiques). C'est:
tmp = sanitizeInput (test)
reconstructMath (tmp [0], tmp [1]) == essai
doit toujours être évaluée à true

Exigences :.

• Python