{
"info": {
"author": "Manuel Barkhau",
"author_email": "mbarkhau@gmail.com",
"bugtrack_url": null,
"classifiers": [
"Development Status :: 4 - Beta",
"Environment :: Console",
"Environment :: Other Environment",
"Intended Audience :: Developers",
"License :: OSI Approved :: MIT License",
"Operating System :: MacOS :: MacOS X",
"Operating System :: Microsoft :: Windows",
"Operating System :: POSIX",
"Operating System :: Unix",
"Programming Language :: Python",
"Programming Language :: Python :: 2.7",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: Implementation :: CPython",
"Programming Language :: Python :: Implementation :: PyPy",
"Topic :: Software Development :: Libraries",
"Topic :: Software Development :: Libraries :: Python Modules"
],
"description": "\n# [markdown-katex][repo_ref]\n\nThis is an extension for [Python Markdown](https://python-markdown.github.io/)\nwhich adds [KaTeX](https://katex.org/) support.\n\n ```math\n f(x) = \\int_{-\\infty}^\\infty\n \\hat f(\\xi)\\,e^{2 \\pi i \\xi x}\n \\,d\\xi\n ```\n\n
\n
\n\n
\n
\n\nProject/Repo:\n\n[![MIT License][license_img]][license_ref]\n[![Supported Python Versions][pyversions_img]][pyversions_ref]\n[![CalVer v202112.1034][version_img]][version_ref]\n[![PyPI Version][pypi_img]][pypi_ref]\n[![PyPI Downloads][downloads_img]][downloads_ref]\n\nCode Quality/CI:\n\n[![GitHub CI Status][github_build_img]][github_build_ref]\n[![GitLab CI Status][gitlab_build_img]][gitlab_build_ref]\n[![Type Checked with mypy][mypy_img]][mypy_ref]\n[![Code Coverage][codecov_img]][codecov_ref]\n[![Code Style: sjfmt][style_img]][style_ref]\n\n\n| Name | role | since | until |\n|-------------------------------------|-------------------|---------|-------|\n| Manuel Barkhau (mbarkhau@gmail.com) | author/maintainer | 2019-05 | - |\n\n\n## Install\n\n```bash\n$ pip install markdown-katex\n...\n$ python -m markdown_katex --version\nmarkdown-katex version: v202112.1034 (using binary: /usr/local/bin/npx --no-install katex)\n0.15.1\n```\n\nThis package includes the following binaries:\n\n - `katex_v0.15.1_node10_x86_64_Linux`\n _ `katex_v0.15.1_node10_x86_64_Darwin`\n _ `katex_v0.15.1_node12_x86_64_Windows`\n\nIf you are on a different platform, or want to use a more recent version of `katex-cli`, you will need to [install it via npm][href_katexinstall_cli].\n\n```bash\n$ npx katex\n$ npx katex --version\n0.15.1\n```\n\nThis extension will always use the locally installed version of KaTeX if it is available, instead of using the implementation bundled with this package.\n\nNo JavaScript is required to render the resulting HTML, so it can be used with more limited renderers (which don't support JavaScript) such as [WeasyPrint](https://weasyprint.org/) .\n\n\n## Usage\n\nFormulas can be created and edited interactively using the editor on [katex.org](https://katex.org/). They also have some [good documentation][href_katex_docs] for the subset of LaTeX that is supported. When embedding these in your Markdown files, they must be marked with a special syntax in order to be rendered using KaTeX. There are [many syntax extensions][href_cben_mathdown] for Markdown that allow LaTeX formulas to be embedded, however this package only supports the syntax introduced by Gitlab:\n\n - For inline mode formulas: $`...`$\n - For display mode formulas: ```math\n\nHere is [an example](https://gitlab.com/snippets/1857641) that uses this syntax.\n\nThere are two main advantages of this syntax:\n\n 1. Gitlab has an existing Markdown renderer that can be used without the need to download any software. This implementation also uses KaTeX, so the output should be exactly the same as this extension.\n 2. The fallback behaviour of other Markdown renderers is to render the raw LaTeX as inline code or a code block. This means that they won't inadvertently parse a LaTeX formula as Markdown syntax.\n\nHopefully other renderers will also adopt support for this syntax as:\n\n 1. Rendering is done in the browser using KaTeX so implementation effort and should be minimal.\n 2. The false positive rate for existing Markdown documents is negligible (i.e. existing alternate use of $` syntax is minimal to non-existent).\n\n\n## Options\n\n - `no_inline_svg`: Replace inline `
![](\"https://raw.githubusercontent.com/mbarkhau/markdown-katex/master/markdown-katex-example.png\")
\n