This plugin adds stylesheets to your mkdocs site from Sass/SCSS.
- using LibSass with libsass-python.
-
Install the package with pip:
pip install mkdocs-extra-sass-plugin
-
Enable the plugin in your
mkdocs.yml:plugins: - extra-sass
Note: If you have no
pluginsentry in your config file yet, you'll likely also want to add thesearchplugin. MkDocs enables it by default if there is nopluginsentry set, but now you have to enable it explicitly. -
Create a
extra_sassdirectory in your working directory (usually the same directory asmkdocs.yml), and create entry point file namedstyle.css.sassorstyle.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.
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.