Skip to main content

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

Project description

mkdocs-extra-sass-mathshim

PyPI version PyPI downloads


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.

Project details


Download files

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

Source Distribution

mkdocs_extra_sass_mathshim-0.1.1.tar.gz (7.1 kB view details)

Uploaded Source

Built Distribution

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

mkdocs_extra_sass_mathshim-0.1.1-py3-none-any.whl (8.0 kB view details)

Uploaded Python 3

File details

Details for the file mkdocs_extra_sass_mathshim-0.1.1.tar.gz.

File metadata

  • Download URL: mkdocs_extra_sass_mathshim-0.1.1.tar.gz
  • Upload date:
  • Size: 7.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: pdm/2.22.3 CPython/3.10.6 Linux/5.15.0-125-generic

File hashes

Hashes for mkdocs_extra_sass_mathshim-0.1.1.tar.gz
Algorithm Hash digest
SHA256 3388c22e2fa59381ff3c38a408cd77e3670537b33e72b0509ce30cba53d18daa
MD5 c6b519e13046560e07dc84a0a5b6b591
BLAKE2b-256 42d6e11922711479cb61e8ef8beeee0a0fb4be6ba09374b9689b93a04efd42b4

See more details on using hashes here.

File details

Details for the file mkdocs_extra_sass_mathshim-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for mkdocs_extra_sass_mathshim-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2c14fba39b1a9c2740429e46d4771dbf389d1333ac17df9aa106bade66150dfb
MD5 dae9b861aa74967f8f70d9238da86394
BLAKE2b-256 ce9b810838a78c973cae08e485d0fcab13a9ec1a288785d0509d6133ce5e08d5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page