math-svg: A Plugin for Pelican

License

Render math expressions to svg and embed them.

Installation

This plugin can be installed via:

python -m pip install pelican-math-svg

Afterwards, add the plugin to the PLUGINS list in your pelicanconf.py file, e.g.:

PLUGINS = [
    "math_svg",
]

Multi-Core Rendering

To use multi-core rendering of equations (highly recommended, especially when many equations have to be rendered) change the html target in the Makefile of your pelican site to a three step process:

html:
    PELICAN_MATH_SVG_DRY=True "$(PELICAN)" "$(INPUTDIR)" -o "$(OUTPUTDIR)" -s "$(CONFFILE)" $(PELICANOPTS)
    pelican-math-svg render -j $(shell nproc)
    "$(PELICAN)" "$(INPUTDIR)" -o "$(OUTPUTDIR)" -s "$(CONFFILE)" $(PELICANOPTS)

The first commands will execute math-svg in dry-mode and only populate the equation database without actually rendering anything. The second command will render all missing equations in parallel. The number of threads is specified by the -j flag, in this example all CPU cores are used. Replace $(shell nproc) with a number to use a fixed number of cores. The last command is the usual pelican command and produces the output files again, know including the rendered equations.

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)
- pdfcrop
- dvisvgm
scour (optional)
svgo (optional)

Usage

In Markdown you can use $x$ for inline math and

$$
  \int x^2
$$

for display math.

It is required to set the stroke color using the strokeonly class (this class name can be changed, see configuration options below), otherwise lines would be rendered white:

svg path.strokeonly {
    color: #000;
}

To change the fill color for equations as well, thus essential changing the default color for math, specify the following additionally:

span.math svg path,
div.math svg path {
    fill: #000;
}

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["strokeonly_class]`	CSS class for SVG paths that have no filling and a black stroke color, useful when changing the color of rendered equations	`strokeonly`
`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[preview,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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pelican-math-svg-0.10.2.tar.gz (22.8 kB view details)

Uploaded Oct 2, 2022 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

pelican_math_svg-0.10.2-py3-none-any.whl (22.9 kB view details)

Uploaded Oct 2, 2022 Python 3

File details

Details for the file pelican-math-svg-0.10.2.tar.gz.

File metadata

Download URL: pelican-math-svg-0.10.2.tar.gz
Upload date: Oct 2, 2022
Size: 22.8 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: poetry/1.2.1 CPython/3.10.7 Linux/5.15.0-1020-azure

File hashes

Hashes for pelican-math-svg-0.10.2.tar.gz
Algorithm	Hash digest
SHA256	`bb5733e9bcdea75e3f24015517b68906d7f0dc97c64320695a256f13266d4af1`
MD5	`c75c2d87e2d6dcbd7fe860b2efdb4908`
BLAKE2b-256	`41db0aed1732e0a90b63c1655e1953fd19fbba13c766a41f9eab359c38ed5db6`

See more details on using hashes here.

File details

Details for the file pelican_math_svg-0.10.2-py3-none-any.whl.

File metadata

Download URL: pelican_math_svg-0.10.2-py3-none-any.whl
Upload date: Oct 2, 2022
Size: 22.9 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: poetry/1.2.1 CPython/3.10.7 Linux/5.15.0-1020-azure

File hashes

Hashes for pelican_math_svg-0.10.2-py3-none-any.whl
Algorithm	Hash digest
SHA256	`698c89fcba128d40a06c0c7651ee72b994dda29edd3ac8756aecb3d9b28e701b`
MD5	`7abd88e3f8027cb5c1b911bbfbb58c6e`
BLAKE2b-256	`1cdd33b91f585a55250c5764707e77c69f6c85f7a6a98915950e7358aa94db9e`