markdown2Mathjax

markdown2Mathjax on yksinkertainen paketti, jonka avulla voit käyttää latex tyyli matematiikka tuottamat MathJax yhdessä suositun markdown muodossa. & Nbsp; On kaksi toteutuksia markdown Python, tämä paketti on suunniteltu käytettäväksi laajemmin käytetty ja aktiivisesti yllä kahden, nimeltään markdown2. Tyypillinen käyttö on seuraava:
#! / Usr / bin / env python
alkaen markdown2Mathjax tuonti sanitizeInput, reconstructMath
alkaen markdown2 tuonti markdown
tmp = sanitizeInput (sometxt)
markdedDownText = markdown (tmp [0])
finalOutput = reconstructMath (markedDownText, tmp [1])
(Jossa "sometxt" on merkkijono, joka sisältää markdown + mathjax tekstiä.)
Asennus
markdown2Mathjax isännöi pypi, joten voidaan asentaa joko lähteestä käyttäen:
terva zxvf markdown2Mathjax-x.x.x.tar.gz
cd markdown2Mathjax-x.x.x
python setup.py asentaa
tai käyttämällä PIP (tai easy_install jos et halua):
Pip asentaa markdown2Mathjax
Käyttö
Oletuksena matematiikka on merkitty yksi $ merkkejä inline matematiikan ja kaksinkertainen $$ merkkejä yhtälöt. Kuitenkin mitä tahansa rajaava merkkijonoja voidaan käyttää muuttamalla avainsanan argumentteja sanitizeInput ja reconstructMath toimintoja. Huomaa, että oletusarvoisesti mathjax ei käytä yhden dollarin merkkejä rajata inline matematiikkaa, joten jos käytät oletusasetuksia paketin, sinun täytyy pyytää mathjax käsitellä sitä asianmukaisesti.
Selitys
SanitizeInput toiminto havaitsee esiintymät matematiikka (määritettynä toimitukseen rajoittimien) ja korvaa ne paikanvaraajaan. Tämä placeholder voidaan määrittää käyttäjän, mutta se on suositeltavaa käyttää mukana oletuksena "0 dollaria $". Placeholder on oltava jotain, joka ei käsitellä markdown, eikä koskaan tuotettu markdown. Ensimmäinen näistä vaatimuksista on helppo riitä vastaamaan, toinen voi olla hieman hienovaraisempia. Jos paikanvaraajan jo toimitettu käyttäjän tekstiä, se on todennut sanitizeInput ja jää yksin, kun jälleenrakennus matematiikka jälkeen markdown käsittelyn.
Aina voimassa matematiikka lohko kohdataan ja korvataan placeholder, matematiikka tallennetaan (nimellä codeblocks), joka sitten palauttaa sanitizeInput toiminto. Jokainen merkintä codeblocks edeltää joko 0 (varten kirjaimellinen esiintyminen paikanvaraajakuvan tekstissä), 1 inline matematiikka tai 2 erillistä yhtälö.
Desinfioidaan merkkijonon sanitizeInput voidaan merkitä ylös markdown pelkäämättä matematiikka on mangled. Lopuksi reconstructMath korvaa kukin paikanvaraajat Tekstitiedostoon asianmukaiset koodilohkoa. Tämä lopullinen html voi sitten näyttää sopivilla mathjax javascript otsikot.
Toinen tapa ajatella tätä on kuin reconstructMath on pohjimmiltaan käänteistä sanitizeInput. Joten ilman markdown välillä, mikään ei saisi vaihtaa kahden (paitsi jos reconstructMath tekee myös joitakin ylimääräisiä siivous on matematiikka codeblocks). Se on:
tmp = sanitizeInput (testi)
reconstructMath (tmp [0], tmp [1]) == testi
tulisi aina on tosi.

Vaatimukset :

• Python