markdown2Mathjax

markdown2Mathjax er en simpel pakke, der tillader dig at bruge latex stil matematik genereret af MathJax i samarbejde med det populære markdown format. & Nbsp; Der er to implementeringer af værdien i python, er denne pakke designet til brug med den mere udbredte og aktivt opretholdes af de to, kaldet markdown2. Typisk brug 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])
(Hvor "sometxt" er en streng, der indeholder markdown + mathjax tekst.)
Installation
markdown2Mathjax er hostet på pypi, så kan installeres enten fra kilde, idet:
tar zxvf markdown2Mathjax-x.x.x.tar.gz
CD markdown2Mathjax-x.x.x
python setup.py installere
eller ved hjælp af pip (eller easy_install hvis du foretrækker):
pip installere markdown2Mathjax
Anvendelse
Som standard er matematik præget af enkelt $ tegn for inline matematik og dobbelt $$ tegn for ligninger. Dog kan nogen afgrænsende strenge benyttes ved at ændre søgeord argumenter til sanitizeInput og reconstructMath funktioner. Bemærk, at som standard mathjax bruger ikke enkelt dollars tegn til at afgrænse inline matematik, så hvis du bruger standardindstillingerne for denne pakke, bliver du nødt til at instruere mathjax at behandle det hensigtsmæssigt.
Forklaring
Den sanitizeInput funktionen finder alle tilfælde af matematik (som bestemt ved de medfølgende skilletegn) og erstatter dem med en pladsholder. Denne pladsholder kan angives af brugeren, men det anbefales, at du bruger den medfølgende standard af "$ 0 $". Den pladsholder skal være noget, der ikke vil blive behandlet af markdown, og vil ikke nogensinde blive produceret af markdown. Den første af disse krav er let nok til at opfylde, kan den anden være noget mere subtil. Hvis der allerede findes pladsholderen i den medfølgende bruger tekst, bemærkes af sanitizeInput og vil blive efterladt alene, når genopbygningen matematik efter markdown forarbejdning.
Hver gang en gyldig matematik blok er stødt på, og erstattes af en pladsholder, er matematik gemt i en liste (kaldet codeblocks), der derefter returneres af sanitizeInput funktionen. Hver post i codeblocks er foranstillet med enten 0 (for en bogstavelig forekomst af pladsholderen i teksten), en 1 til inline matematik eller et 2 for en særskilt ligning.
Den desinficeret snor fra sanitizeInput kan derefter markeret ved markdown uden frygt for din matematik er lemlæstede. Endelig reconstructMath erstatter hver af pladsholdere i markeret tekst med passende codeblock. Denne endelige html kan derefter vises med passende mathjax javascript overskrifter.
En anden måde at tænke på dette er end reconstructMath er dybest set det modsatte af sanitizeInput. Så uden at bruge værdien i mellem, bør intet skifte mellem de to (undtagen når reconstructMath også gør nogle ekstra oprydning af de matematiske codeblocks). Det er:
tmp = sanitizeInput (test)
reconstructMath (TMP [0], tmp [1]) == test
bør altid vurdere, sand

Krav :.

• Python