mkdocs-extra-sass-mathshim 0.1.0

A fork of mkdocs-extra-sass-plugin with math function shims for non-Dart Sass.

mkdocs-extra-sass-mathshim

---

This plugin adds stylesheets to your MkDocs site from Sass/SCSS and includes shims for math functions—such as math.round() and math.div()—so you can use modern module syntax while using non‑Dart Sass (i.e. LibSass).

Features

• Uses LibSass with libsass-python.
• Provides math function shims to translate calls like math.round() to the older, supported equivalents.

How to use

Installation

1. Install the package with pip:

   pip install mkdocs-extra-sass-mathshim
   

2. Enable the plugin in your mkdocs.yml:

   plugins:
     - extra-sass
   

   Note: If you have no plugins entry in your config file yet, you'll likely also want to add the search plugin. MkDocs enables it by default if there is no plugins entry set, but now you have to enable it explicitly.

3. Create an extra_sass directory in your working directory (usually the same directory as mkdocs.yml), and create an entry point file named either style.css.sass or style.css.scss:

   (top)
   ├── docs
   │   ...snip...
   │   └── index.md
   ├── extra_sass
   │   ...snip...
   │   └── style.css.scss  # Compiler entry point file.
   └── mkdocs.yml
   

More information about MkDocs plugins is available in the MkDocs documentation.

Contributing

Every contribution is appreciated—whether you're reporting a bug, asking a question, or submitting a pull request. Please report bugs or request features via Github issues.
If you want to contribute code, please read the Contribution Guidelines.