Skip to content

ilPode/python-asciimathmd

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 

Repository files navigation

ASCIIMathML Markdown

Description

Extension for Python Markdown wich adds math support in ASCIIMathML syntax. This extension provides inline, block math and equation numbering with references.

The parsing code is taken from here, the only thing I did is adding the math block and numbering system.

Usage

To add inline math to your text enclose it in ~ :

blah blah ~ e^(ix) = cos(x) + i sin(x) ~ blah blah

To start a math block put a [~ref] at the beginning of the line, and end it with a blank line. To insert a line break in a math block just put two spaces before a newline, like in standard markdown syntax. You can reference an equation in the text with [~ref]:

blah blah
[~1] e^(ix) = cos(x) + i sin(x)  
     cos(x) = (e^(ix) + e^(-ix))/2
     sin(x) = (e^(ix) - e^(-ix))/(2i)

I love equation [~1].

Configuration

The equation reference number can be global or preceded by header's number (like in (1.2.3)). You can set the preferred behaviour using this config parameters:

  • level_num : Maximum level of header to keep track of (Default is 1).
    • level_num = -1 : No header's number (global equation's number).
    • level_num = 0 : Numbers only on h1.
    • level_num = 1 : Numbers on h1 and h2.
    • ...
    • level_num = 6 : Numbers on all headers from h1 to h6 (please don't do this).
  • header_num: Wether or not to show the number near the header (Default is True)

About

ASCIIMathML extension for Python Markdown

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages