markdown2Mathjax

markdown2Mathjax är ett enkelt paket som låter dig använda latex stil matte genereras av MathJax i samband med den populära markdown-format. & Nbsp; Det finns två implementeringar av markdown i python, är detta paket utformad för att användas med mer utbredda och aktivt underhålls av de två, som kallas markdown2. Typisk användning är som följer:
#! / Usr / bin / env python
från markdown2Mathjax import sanitizeInput, reconstructMath
från markdown2 importmarkdown
tmp = sanitizeInput (sometxt)
markdedDownText = markdown (TMP [0])
finalOutput = reconstructMath (markedDownText, tmp [1])
(Där "sometxt" är en sträng som innehåller markdown + mathjax text.)
Installation
markdown2Mathjax är värd på pypi, så kan installeras antingen från källan, med hjälp av:
tar zxvf markdown2Mathjax-x.x.x.tar.gz
cd markdown2Mathjax-x.x.x
Python setup.py installera
eller använda pip (eller easy_install om du föredrar):
Pip installera markdown2Mathjax
Användning
Som standard är matte präglas av enkla $ skyltar för inline matematik och dubbla $$ skyltar för ekvationer. Dock kan eventuella avgränsande strängar användas genom att ändra sökords argumenten till sanitizeInput och reconstructMath funktioner. Observera att som standard mathjax Använder inte enstaka dollar tecken för att avgränsa inline matte, så om du använder standardinställningarna för detta paket, måste du instruera mathjax att behandla det på lämpligt sätt.
Förklaring
Den sanitizeInput funktionen hittar några fall av matte (som bestäms av de medföljande avgränsare) och ersätter dem med en platshållare. Denna platshållare kan anges av användaren, men det rekommenderas att du använder den medföljande standard för "$ 0 $". Platshållaren måste vara något som inte kommer att behandlas av markdown, och kommer aldrig att produceras av markdown. Den första av dessa krav är lätt att möta, kan den andra vara något mer subtil. Om platshållare redan finns i den medföljande användartexten, noteras av sanitizeInput och kommer att lämnas ensam när återuppbyggnads matte efter markdown bearbetning.
Varje gång en giltig matte blocket påträffas och ersätts med en platshållare, är matten sparas i en lista (som kallas codeblocks) som sedan returneras av sanitizeInput funktionen. Varje post i codeblocks har prefixet antingen 0 (för en bokstavlig förekomst av platshållaren i texten), en 1 för inline matte eller 2 för en separat ekvation.
Den sanerade sträng från sanitizeInput kan sedan märkas upp med markdown utan rädsla för din matte är sargade. Slutligen reconstructMath ersätter varje platshållare i uppmärkt text med rätt codeblock. Denna sista html kan sedan visas med lämplig mathjax javascript rubriker.
Ett annat sätt att tänka på detta är än reconstructMath är i grunden inversen av sanitizeInput. Så utan att använda markdown i mellan, bör inget förändras mellan de två (förutom när reconstructMath också gör lite extra sanering av de matematiska codeblocks). Det är:
tmp = sanitizeInput (test)
reconstructMath (tmp [0], tmp [1]) == testet
bör alltid utvärderas till true

Krav :.

• Python