markdown2Mathjax

markdown2Mathjax простой пакет, который позволяет использовать латекс стиль математику, сгенерированный MathJax в сочетании с популярным форматом уценки & NBSP;. Есть две реализации уценки в питона, этот пакет предназначен для использования с более широко используется и активно поддерживается из двух, называется markdown2. Типичное использование заключается в следующем:
#! / USR / бен / ENV питон
от markdown2Mathjax импорта sanitizeInput, reconstructMath
от markdown2 импорта уценки
TMP = sanitizeInput (sometxt)
markdedDownText = уценки (TMP [0])
finalOutput = reconstructMath (markedDownText, TMP [1])
(где "sometxt" является строка, содержащая уценки + MathJax текст.)
Установка
markdown2Mathjax размещен на PyPI, поэтому может быть установлен либо от источника, с помощью:
TAR zxvf markdown2Mathjax-x.x.x.tar.gz
CD-x.x.x markdown2Mathjax
питон setup.py установить
или с помощью PIP (или easy_install, если вы предпочитаете):
пункт установить markdown2Mathjax
Использование
По умолчанию, математика отмечается одиночными символами $ для встроенного математике и двойных знаков $$ для уравнений. Тем не менее, любые разделения строк может быть использован путем изменения именованные аргументы для функций sanitizeInput и reconstructMath. Обратите внимание, что по умолчанию MathJax НЕ использовать одинарные долларов признаки для разделения встроенного математику, так что если вы используете значения по умолчанию для этого пакета, вам придется поручить MathJax лечить его соответствующим образом.
Объяснение
Функция sanitizeInput находит все экземпляры математике (как определено поставляемых разделителей) и заменяет их заполнителя. Это заполнитель может быть задана пользователем, но рекомендуется использовать прилагаемый умолчанию "$ 0 $". Заполнитель должен быть то, что не будут обрабатываться уценки и никогда не будет, произведенные уценки. Первый из этих требований достаточно просто встретиться, вторая может быть несколько более тонким. Если заполнитель уже существует в прилагаемом тексте пользователя, он отметил sanitizeInput и оставили в покое, когда реконструкция математике после обработки уценки.
Каждый раз, когда действует математике блок встречается и заменена на заполнитель, математика сохраняется в списке (называемые CodeBlocks), который затем возвращается функцией sanitizeInput. Каждая запись в CodeBlocks с префиксом или 0 (для буквальном вхождению заполнителя в тексте), а 1 для встроенного математике или в 2 для отдельного уравнения.
Санитарно обработанную строку из sanitizeInput может быть размечена с уценкой, без страха быть ваша математика подогнаны. Наконец, reconstructMath заменяет каждый из заполнителей в размеченный текст с соответствующим кодоблок. Этот последний HTML может отображаться с соответствующим MathJax яваскрипта заголовки.
Еще один способ думать о чем это reconstructMath в основном обратная sanitizeInput. Так что без помощи уценки между ними, ничего не должно измениться между двумя (кроме случаев, когда reconstructMath также делает некоторые дополнительные очистка математике CodeBlocks). То есть:
TMP = sanitizeInput (тест)
reconstructMath (TMP [0], TMP [1]) == тест
всегда должны оценить, верно

Требования :.

• Python