Project

jekyll-asciimath

0.0
No commit activity in last 3 years
No release in over 3 years
jekyll-asciimathriboseinc/jekyll-asciimathHomepageDocumentationSource CodeBug Tracker
AsciiMath plugin for Jekyll
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
3,718
Stars
0
Forks
1
Watchers
9
 Releases
Current version
1.1.0
Total releases
2
First release
2020-04-11
Latest release
2020-04-19
 Issues
Open Issues
2
Closed Issues
0
Total Issues
2
Issue Closure Rate
0%
 Pull Requests
Open Pull Requests
1
Closed Pull Requests
0
Merged Pull Requests
0
Pull Request Acceptance Rate
0%
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2020-04-18
Reverse Dependencies
0

 Dependencies

Development

rake
~> 12.0
rubocop
~> 0.50

Runtime

asciimath
~> 1.0.9
jekyll
~> 4.0
 Project Readme

AsciiMath plugin for Jekyll

Useful when you want to render AsciiMath markup at build time, rather than using client-side JS processing.

Important
 This plugin uses https://github.com/asciidoctor/asciimath, which as of now does not support all features of AsciiMath. Certain advanced math symbols may not be rendered correctly.

asciimath filter

When applied to a variable, replaces AsciiMath markup between specified delimiters with MathML or HTML.

For example, Liquid markup like this:

{% assign some_variable = "$$m$$ out of $$n$$ redundancy" %}
{{ some_variable | asciimath }}

…would be rendered into the following MathML (whitespace in rendering examples is added for legibility):

<math>
  <mi>m</mi>
</math>

out of

<math>
  <mi>n</mi>
</math>

redundancy

…or following HTML:

<span class="math-inline">
  <span class="math-row">
    <span class="math-identifier">m</span>
  </span>
</span>

out of

<span class="math-inline">
  <span class="math-row">
    <span class="math-identifier">n</span>
  </span>
</span>

redundancy

How it works

This plugin uses https://github.com/asciidoctor/asciimath for converting AsciiMath into MathML and HTML, and a crude regular expression for extracting AsciiMath markup from a mass of text based on delimiters.

Configuration

The plugin will work without any extra configuration, but you should keep in mind that it uses MathML output by default (subject to browser support) and pay attention to the delimiter setting (see below).

Output format

Depending on the browsers you intend to support, you may choose MathML or HTML as the output format.

asciimath_output_format: mathml

Valid choices: mathml (default), html.

Note
 MathML rendering depends on your user agent’s support of MathML.
Note
 HTML output works across wider range of browsers, but requires the inclusion of a CSS file (see the relevant section in this document).

Delimiter

Currently, only one delimiter is supported (i.e., opening delimiter must be the same as trailing delimiter).

Configure the delimiter for use with asciimath filters in your site config as follows:

asciimath_delimiter: $$

The default delimiter is $$.

Note
 If you have jekyll-asciidoc gem process stem: markup in your sources, you may want to keep in mind that its output will use \$ as delimiter.
Note
 Delimiter will be passed to Ruby’s Regexp.quote(), so there’s no need to quote special characters.

Styling

For the HTML output of asciimath filter to be rendered correctly, you have to include the relevant CSS.

The plugin automatically copies the CSS file from the asciimath gem distribution into the assets directory of your site output.

To change the path to CSS, specify the asciimath_css_dir option:

asciimath_css_path: assets/math.css

To disable this behavior, set that variable to empty string.

The default path is assets/math.css.

Important

The plugin will only copy the CSS file, but it will not include it your website’s source. Add the relevant <link> in your template like this:

<head>
  <!-- ...other markup... -->
  <link href="{{ "/assets/math.css" | relative_url }}" />
</head>