markdown2Mathjax

.

markdown2Mathjax size lateks tarzı popüler markdown formatı ile birlikte MathJax tarafından oluşturulan matematik & nbsp kullanmanıza olanak sağlar basit bir paket, Python markdown iki uygulamaları vardır, bu paket daha yaygın olarak kullanılan kullanılmak üzere tasarlanmıştır ve aktif olarak iki adlandırılan markdown2 ve muhafaza. Aşağıdaki gibi tipik kullanımı ise:
#! / Usr / bin / env python
markdown2Mathjax ithalat sanitizeInput, reconstructMath gelen
markdown2 ithalat markdown gelen
tmp = sanitizeInput (sometxt)
markdedDownText = markdown (TMP [0])
finalOutput = reconstructMath (markedDownText, tmp [1])
(Burada "sometxt" markdown + mathjax metin içeren bir dizedir.)
Kurulum
markdown2Mathjax pypi üzerinde barındırılan, böylece kullanarak, ya kaynağından monte edilebilir:
tar zxvf markdown2Mathjax-x.x.x.tar.gz
CD markdown2Mathjax-x.x.x
piton setup.py install
ya da (ya da tercih ederseniz easy_install) pip kullanarak:
markdown2Mathjax yüklemek pip
Kullanım
Varsayılan olarak, matematik satır içi matematik ve denklemler için çift $$ işaretler için tek $ işaretleri ile işaretlenir. Bununla birlikte, herhangi bir sınırlandırma şeritler sanitizeInput ve reconstructMath işlevlerine kelime argümanlar değiştirilerek kullanılabilir. Varsayılan olarak mathjax satır içi matematik sınırlandırmak için tek dolar işaretleri kullanmak DEĞIL unutmayın, bu yüzden bu paket için varsayılan kullanırsanız, uygun şekilde tedavi etmek için mathjax talimat zorunda kalacak.
Açıklama
sanitizeInput fonksiyonu matematik herhangi örneklerini bulur (ürünle sınırlayıcılar ile belirlendiği gibi) ve bir yer tutucu ile değiştirir. Bu tutucu, kullanıcı tarafından belirlenen olabilir, ama o "$ 0 $" nin verilen varsayılan kullanmanız önerilir. tutucu markdown tarafından işleme alınmayacaktır şey olmak zorunda, ve hiç markdown tarafından ÜRETİLEN olmayacaktır. Bu gereksinimleri karşılamak için ilk yeterince kolaydır, ikinci biraz daha ince olabilir. Tutucu zaten verilen kullanıcı metin varsa, bu sanitizeInput tarafından kaydetti ve yalnız kalacak ne zaman markdown işlendikten sonra yeniden yapılanma matematik.
Geçerli bir matematik blok tutucu ile karşılaştı ve yerini her zaman, matematik ardından sanitizeInput işlevi tarafından döndürülen bir liste (denir codeblocks) kaydedilir. Kod-blokları her giriş, ayrı bir denklem için, (metinde yer tutucu bir edebi gelişiminden) ya 0 ile bir satır içi matematik için 1 veya 2 öneki.
sanitizeInput dan dezenfekte dize sonra matematik karıştırılmış olma korkusu olmadan markdown tarafından işaretlenebilir. Son olarak, reconstructMath uygun codeblock ile işaretlenmiş metnin içinde yer tutucuların her yerini alır. Bu son html sonra javascript başlıklar uygun mathjax ile görüntülenebilir.
Bu düşünmek için başka bir yolu reconstructMath temelde sanitizeInput tersidir daha. Yani arada Markdown kullanmadan, hiçbir şey (reconstructMath ayrıca matematik kod-blokları bazı ekstra temizleme yaptığında hariç) ikisi arasında değişmelidir. Yani:
tmp = sanitizeInput (test)
reconstructMath (tmp [0], tmp [1]) == testi
her zaman true değerlendirmelidir

Gereksinimler :.

• Python