mkdocs-extra-sass-plugin

mkdocs-extra-sass-plugin

---

This plugin adds stylesheets to your mkdocs site from Sass/SCSS.

Features

• using LibSass with libsass-python.

How to use

Installation

1. Install the package with pip:

   pip install mkdocs-extra-sass-plugin
   

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 a extra_sass directory in your working directory (usually the same directory as mkdocs.yml), and create entry point file named style.css.sass or style.css.scss.

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

More information about plugins in the MkDocs documentation.

Contributing

From reporting a bug to submitting a pull request: every contribution is appreciated and welcome. Report bugs, ask questions and request features using Github issues. If you want to contribute to the code of this project, please read the Contribution Guidelines.