Math extension for Python-Markdown
Verified details
These details have been verified by PyPIProject links
GitHub Statistics
Maintainers
Project description
Math extension for Python-Markdown
This extension adds math formulas support to Python-Markdown.
Installation
Install from PyPI
$ pip install python-markdown-math
Install locally
Use pip install . to install this extension from a local Git checkout.
The extension name is mdx_math, so you need to add that name to your
list of Python-Markdown extensions.
Check Python-Markdown documentation for details on how to load
extensions.
Usage
To use this extension, you need to include MathJax library in HTML files, like:
<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js">
</script>
Also, you need to specify a configuration for MathJax. Please note that
most of standard configurations include tex2jax extension, which is not needed
with this code.
Example of configuration for MathJax 2.x:
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
config: ["MMLorHTML.js"],
jax: ["input/TeX", "output/HTML-CSS", "output/NativeMML"],
extensions: ["MathMenu.js", "MathZoom.js"]
});
</script>
If you want to use MathJax 3.x, you need to teach it to understand 2.x-style
<script> tags. See the upgrading documentation on how to do it.
Alternatively, you may use the Arithmatex extension which has a generic
output mode, that does not require such special configuration.
To pass the extension to Python-Markdown, use mdx_math as extension name.
For example:
>>> md = markdown.Markdown(extensions=['mdx_math'])
>>> md.convert('$$e^x$$')
'<p>\n<script type="math/tex; mode=display">e^x</script>\n</p>'
Usage from the command line:
$ echo "\(e^x\)" | python3 -m markdown -x mdx_math
<p>
<script type="math/tex">e^x</script>
</p>
Math Delimiters
For inline math, use \(...\).
For standalone math, use $$...$$, \[...\] or \begin...\end.
The single-dollar delimiter ($...$) for inline math is disabled by
default, but can be enabled by passing enable_dollar_delimiter=True
in the extension configuration.
If you want to use GitLab-style delimiters ($`...`$ for inline math,
and a code block-like ```math...``` syntax for standalone), use
use_gitlab_delimiters=True configuration option.
If you want to this extension to generate a preview node (which will be shown
when MathJax has not yet processed the node, or when JavaScript is unavailable),
use add_preview=True configuration option.
Notes
If you use ReText, this extension is not needed as it is included by default.
This extension also works with Katex. Use the following in your page <head>:
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/katex/dist/katex.min.css" crossorigin="anonymous">
<script src="https://cdn.jsdelivr.net/npm/katex/dist/katex.min.js" crossorigin="anonymous"></script>
<script src="https://cdn.jsdelivr.net/npm/katex/dist/contrib/mathtex-script-type.min.js" defer></script>
Project details
Verified details
These details have been verified by PyPIProject links
GitHub Statistics
Maintainers
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file python_markdown_math-0.9.tar.gz.
File metadata
- Download URL: python_markdown_math-0.9.tar.gz
- Upload date:
- Size: 8.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 567395553dc4941e79b3789a1096dcabb3fda9539d150d558ef3507948b264a3 |
|
| MD5 | bf39178e65055cefaafe278cfb6ef059 |
|
| BLAKE2b-256 | 4c68fbea05ec6fb318bdcf56ea47596605614554f51d77bfd14f6fb481139ad8 |
Provenance
The following attestation bundles were made for python_markdown_math-0.9.tar.gz:
Publisher:
main.yml on mitya57/python-markdown-math
-
Statement:
- Statement type:
https://in-toto.io/Statement/v1 - Predicate type:
https://docs.pypi.org/attestations/publish/v1 - Subject name:
python_markdown_math-0.9.tar.gz - Subject digest:
567395553dc4941e79b3789a1096dcabb3fda9539d150d558ef3507948b264a3 - Sigstore transparency entry: 194876828
- Sigstore integration time:
- Permalink:
mitya57/python-markdown-math@bb6422d9d9e0204940652ba9f6bf93bdfad62f67 - Branch / Tag:
refs/tags/0.9 - Owner: https://github.com/mitya57
- Access:
public
- Token Issuer:
https://token.actions.githubusercontent.com - Runner Environment:
github-hosted - Publication workflow:
main.yml@bb6422d9d9e0204940652ba9f6bf93bdfad62f67 - Trigger Event:
push
- Statement type:
File details
Details for the file python_markdown_math-0.9-py3-none-any.whl.
File metadata
- Download URL: python_markdown_math-0.9-py3-none-any.whl
- Upload date:
- Size: 6.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ac9932df517a5c0f6d01c56e7a44d065eca4a420893ac45f7a6937c67cb41e86 |
|
| MD5 | ac667e886410777855065a136a896078 |
|
| BLAKE2b-256 | eb68ecf3535c40845de2efd8ac2d092dd5fca0868219fa3684d9e58ef7abeece |
Provenance
The following attestation bundles were made for python_markdown_math-0.9-py3-none-any.whl:
Publisher:
main.yml on mitya57/python-markdown-math
-
Statement:
- Statement type:
https://in-toto.io/Statement/v1 - Predicate type:
https://docs.pypi.org/attestations/publish/v1 - Subject name:
python_markdown_math-0.9-py3-none-any.whl - Subject digest:
ac9932df517a5c0f6d01c56e7a44d065eca4a420893ac45f7a6937c67cb41e86 - Sigstore transparency entry: 194876830
- Sigstore integration time:
- Permalink:
mitya57/python-markdown-math@bb6422d9d9e0204940652ba9f6bf93bdfad62f67 - Branch / Tag:
refs/tags/0.9 - Owner: https://github.com/mitya57
- Access:
public
- Token Issuer:
https://token.actions.githubusercontent.com - Runner Environment:
github-hosted - Publication workflow:
main.yml@bb6422d9d9e0204940652ba9f6bf93bdfad62f67 - Trigger Event:
push
- Statement type:
