Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/f-koehler/pelican-math-svg
Render mathematical expressions for your pelican site to SVG in a smart way.
https://github.com/f-koehler/pelican-math-svg
latex math pelican pelican-plugins python tex
Last synced: 2 months ago
JSON representation
Render mathematical expressions for your pelican site to SVG in a smart way.
- Host: GitHub
- URL: https://github.com/f-koehler/pelican-math-svg
- Owner: f-koehler
- License: agpl-3.0
- Created: 2020-11-11T17:10:50.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-06T03:08:20.000Z (2 months ago)
- Last Synced: 2024-11-06T04:18:39.258Z (2 months ago)
- Topics: latex, math, pelican, pelican-plugins, python, tex
- Language: Python
- Homepage:
- Size: 363 KB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# math-svg: A Plugin for Pelican
[](https://github.com/f-koehler/pelican-math-svg/actions)
[](https://pypi.org/project/pelican-math-svg/)
[](https://results.pre-commit.ci/latest/github/f-koehler/pelican-math-svg/main)
Render math expressions to svg and embed them.
## Installation
This plugin can be installed via:
```shell
python -m pip install pelican-math-svg
```
Afterwards, add the plugin to the `PLUGINS` list in your `pelicanconf.py` file, e.g.:
```python
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:
```makefile
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](#configuration))
- `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](#configuration)), otherwise lines would be rendered white:
```css
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:
```css
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 `` 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.
[existing issues]: https://github.com/f-koehler/pelican-math-svg/issues
[contributing to pelican]: https://docs.getpelican.com/en/latest/contribute.html
## License
This project is licensed under the GPLv3 license.