markdown2Mathjax

markdown2Mathjax er en enkel pakke som lar deg bruke latex stil matematikk generert av MathJax i forbindelse med den populære markdown-formatet. & Nbsp; Det er to implementeringer av markdown i python, er denne pakken designet for å brukes med mer utbredt og aktivt opprettholdt av de to, kalt markdown2. Typisk bruk er som følger:
#! / Usr / bin / env python
fra markdown2Mathjax import sanitizeInput, reconstructMath
fra markdown2 import Markdown
tmp = sanitizeInput (sometxt)
markdedDownText = Markdown (tmp [0])
finalOutput = reconstructMath (markedDownText, tmp [1])
(Der "sometxt" er en streng som inneholder markdown + mathjax tekst.)
Installasjon
markdown2Mathjax ligger på PyPI, så kan installeres enten fra kilde, ved hjelp av:
tjære zxvf markdown2Mathjax-x.x.x.tar.gz
cd markdown2Mathjax-x.x.x
python setup.py installere
eller ved hjelp av pip (eller easy_install hvis du foretrekker):
PIP installere markdown2Mathjax
Bruk
Som standard er matematikk preget av enkelt $ skiltene for inline matematikk og doble $$ skiltene til ligninger. Imidlertid kan noen avgrensende strenger brukes ved å endre søkeord argumentene til de sanitizeInput og reconstructMath funksjoner. Vær oppmerksom på at som standard mathjax bruker ikke enkelt dollar tegn til å avgrense inline matematikk, så hvis du bruker standardinnstillingene for denne pakken, må du instruere mathjax å behandle det på riktig måte.
Forklaring
Den sanitizeInput funksjonen finner alle forekomster av matematikk (som bestemmes av de medfølgende skilletegn) og erstatter dem med en plassholder. Denne plassholder kan angis av brukeren, men det anbefales at du bruker den medfølgende standard av "$ 0 $". Plassholderen må være noe som ikke vil bli behandlet av Markdown, og vil aldri bli produsert av Markdown. Den første av disse kravene er lett nok til å møte, kan den andre være litt mer subtil. Hvis det finnes plassholderen allerede i den medfølgende bruker tekst, er det bemerket av sanitizeInput og vil være alene når gjenoppbygging matematikk etter Markdown behandling.
Hver gang en gyldig matematikk blokk er oppstått og erstattet av en plassholder, blir regnestykket som er lagret i en liste (kalt codeblocks) som deretter returneres av sanitizeInput funksjon. Hver oppføring i codeblocks er prefiks med enten 0 (for en bokstavelig forekomst av plassholder i teksten), en en for inline matematikk eller en 2 for en egen ligning.
Den renovert streng fra sanitizeInput kan da bli merket opp med markdown uten frykt for matte være lemlestede. Endelig erstatter reconstructMath hver av plassholdere i merket tekst med riktig codeblock. Denne endelige html kan deretter vises med riktig mathjax javascript overskrifter.
En annen måte å tenke på dette er enn reconstructMath er i utgangspunktet den inverse av sanitizeInput. Så uten å bruke markdown i mellom, bør ingenting skifte mellom de to (bortsett fra når reconstructMath gjør også litt ekstra opprydding av de matematiske codeblocks). Det er:
tmp = sanitizeInput (test)
reconstructMath (tmp [0], tmp [1]) == test
bør alltid vurdere å true

Krav .

• Python