math-svg: A Plugin for Pelican
Render math expressions to svg and embed them.
Installation
This plugin can be installed via:
python -m pip install pelican-math-svg
Requirements
- required LaTeX tools (all included in TeX Live and possibly other LaTeX distributions):
lualatex(or another LaTeX compiler if changed in the settings, see below)pdfcropdvisvgm
scour(optional)svgo(optional)
Configuration
In your pelicanconf.py you can use the following options to tweak the behavior of the plugin:
| Setting | Description | Default Value |
|---|---|---|
| `MATH_SVG["titles"] | Whether to generate <title> tags containing the raw LaTeX code (recommended for accessibility). |
True |
MATH_SVG["scale_inline"] |
scaling factor for inline math | 1.0 |
MATH_SVG["scale_display"] |
scaling factor for display math | 1.0 |
MATH_SVG["latex"]["args"] |
CLI arguments of the invoked LaTeX compiler | "--interaction=errorstopmode", "--halt-on-error" |
MATH_SVG["latex"]["preamble"] |
preamble of the generated LaTeX document | [r"\documentclass[crop,border={2pt 0pt}]{standalone}",r"\usepackage{amsmath}",r"\usepackage{amssymb}",] |
MATH_SVG["latex"]["program"] |
LaTeX compiler to use | lualatex |
MATH_SVG["pdfcrop"]["args"] |
CLI arguments for pdfcrop |
--hires |
MATH_SVG["dvisvgm"]["args"] |
CLI arguments for dvisvgm |
["--pdf", "--optimize=all", "--no-fonts", "--exact-bbox"] |
MATH_SVG["scour"]["args"] |
CLI arguments for scour |
["--strip-xml-prolog", "--remove-descriptions", "--remove-metadata", "--enable-comment-stripping", "--strip-xml-space", "--enable-id-stripping",] |
MATH_SVG["scour"]["enabled"] |
whether to use scour to optimize SVG output |
True if scour is in $PATH, False otherwise |
MATH_SVG["svgo"]["args"] |
CLI arguments for svgo |
["--multipass", "--precision", "5"] |
MATH_SVG["svgo"]["enabled"] |
whether to use svgo to optimize SVG output |
True if svgo is in $PATH, False otherwise |
Contributing
Contributions are welcome and much appreciated. Every little bit helps. You can contribute by improving the documentation, adding missing features, and fixing bugs. You can also help out by reviewing and commenting on existing issues.
To start contributing to this plugin, review the Contributing to Pelican documentation, beginning with the Contributing Code section.
License
This project is licensed under the GPLv3 license.
1 maintainer
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pelican-math-svg-0.6.1.tar.gz.
File metadata
- Download URL: pelican-math-svg-0.6.1.tar.gz
- Upload date:
- Size: 20.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
poetry/1.1.7 CPython/3.7.11 Linux/5.8.0-1039-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c3967f91098a79eaf66809f13a9c169a02d1420633ac89762afd9321948e942b
|
|
| MD5 |
52bc77e4811f7bf083283eabfcb95e82
|
|
| BLAKE2b-256 |
74cdf946b95c8a34fb22c3ba65b7959ae975b416b23504737214c76227896302
|
File details
Details for the file pelican_math_svg-0.6.1-py3-none-any.whl.
File metadata
- Download URL: pelican_math_svg-0.6.1-py3-none-any.whl
- Upload date:
- Size: 21.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
poetry/1.1.7 CPython/3.7.11 Linux/5.8.0-1039-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
976ecfb6d92c24d01f6d81729124dde3c14e893ee3394f66d5fc4b4388f49c0a
|
|
| MD5 |
7f3e424b2943bb5873b5e10605c68db9
|
|
| BLAKE2b-256 |
33ccf3d8af6bd71d79bc800d1f96092214f534625a6bb985f85c524ff9c6d080
|
