mkdocs-bulma-classes-plugin

Add support to Bulma css framework in Mkdocs


Keywords
mkdocs, plugin
License
MIT
Install
pip install mkdocs-bulma-classes-plugin==1.0.0b7

Documentation

Mkdocs Bulma Classes Plugin

Add support to Bulma CSS framework in Mkdocs.

Inspired by mkdocs-bootstrap-tables-plugin.

This plugin inject in the raw html elements produced by Mkdocs from Markdown all necessary classes for styling with Bulma framework.

Table of Contents:

How to Install

Use pip to install the plugin (or use your preferred dep manager for Python, like Poetry for me):

pip install mkdocs-bulma-classes-plugin

and activate the plugin in your mkdocs.yml config file:

plugins:
  - bulma-classes

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.

How to use

You doesn't need to do anything. When you build your docs with Mkdocs, after HTML page generation, this pluging inject in your tags the proper CSS class for Bulma. For example, your # Heading 1 will produce the following HTML code:

<h1 id="heading-1">Heading 1</h1>

but enabling this plugin will produce this:

<h1 id="heading-1" class="title is-1">Heading 1</h1>

necessary for Bulma to render this title:
Bulma title is-1

For more info, look at docs.

See also

Take a look at my Bulma Theme for Mkdocs.