# Mkdocs Bulma Classes Plugin
[](https://github.com/psf/black)
Add support to [Bulma CSS framework](https://bulma.io) in [Mkdocs](https://www.mkdocs.org).
Inspired by [mkdocs-bootstrap-tables-plugin](https://github.com/byrnereese/mkdocs-bootstrap-tables-plugin/blob/master/mkdocs_bootstrap_tables_plugin/plugin.py).
This plugin inject first in the Markdown of the page and then in the raw html elements produced by Mkdocs from Markdown all necessary classes for styling with Bulma framework. I'll try to follow in the most pedantic way the last [CommonMark](https://commonmark.org/) specification released before supporting other versions.
**Table of Contents**:
- [How to Install](#how-to-install)
- [How to use](#how-to-use)
- [See also](#see-also)
## How to Install
Use pip to install the plugin (or use your preferred dep manager for Python, like [Poetry](https://python-poetry.org/) for me):
pip install mkdocs-bulma-classes-plugin
## How to use
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.
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:
For more info, look at [docs](https://daniele-tentoni.github.io/mkdocs-bulma-classes-plugin).
## See also
Take a look at my [Bulma Theme](https://github.com/daniele-tentoni/mkdocs-bulma-theme) for Mkdocs.
## Contributing
Contributions are welcome.
Raw data
{
"_id": null,
"home_page": "https://daniele-tentoni.github.io/mkdocs-bulma-classes-plugin",
"name": "mkdocs-bulma-classes-plugin",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10,<4.0",
"maintainer_email": "",
"keywords": "mkdocs,plugin",
"author": "Daniele Tentoni",
"author_email": "daniele.tentoni.1996@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/aa/a1/07faa72d4c5f28df5552e0c13f6998f91c9bad52684961ecbc1e0771b05c/mkdocs_bulma_classes_plugin-1.0.0b7.tar.gz",
"platform": null,
"description": "# Mkdocs Bulma Classes Plugin\n\n[](https://github.com/psf/black)\n\nAdd support to [Bulma CSS framework](https://bulma.io) in [Mkdocs](https://www.mkdocs.org).\n\nInspired by [mkdocs-bootstrap-tables-plugin](https://github.com/byrnereese/mkdocs-bootstrap-tables-plugin/blob/master/mkdocs_bootstrap_tables_plugin/plugin.py).\n\nThis plugin inject first in the Markdown of the page and then in the raw html elements produced by Mkdocs from Markdown all necessary classes for styling with Bulma framework. I'll try to follow in the most pedantic way the last [CommonMark](https://commonmark.org/) specification released before supporting other versions.\n\n**Table of Contents**:\n\n- [How to Install](#how-to-install)\n- [How to use](#how-to-use)\n- [See also](#see-also)\n\n## How to Install\n\nUse pip to install the plugin (or use your preferred dep manager for Python, like [Poetry](https://python-poetry.org/) for me):\n\n pip install mkdocs-bulma-classes-plugin\n\n## How to use\n\nActivate the plugin in your `mkdocs.yml` config file:\n\n plugins:\n - bulma-classes\n\n> 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.\n\nYou 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:\n\n <h1 id=\"heading-1\">Heading 1</h1>\n\nbut enabling this plugin will produce this:\n\n <h1 id=\"heading-1\" class=\"title is-1\">Heading 1</h1>\n\nnecessary for Bulma to render this title:\n\n\n\nFor more info, look at [docs](https://daniele-tentoni.github.io/mkdocs-bulma-classes-plugin).\n\n## See also\n\nTake a look at my [Bulma Theme](https://github.com/daniele-tentoni/mkdocs-bulma-theme) for Mkdocs.\n\n## Contributing\n\nContributions are welcome.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Add support to Bulma css framework in Mkdocs",
"version": "1.0.0b7",
"split_keywords": [
"mkdocs",
"plugin"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "232cf7fef161fcfa26d1b0bb7dc9b6aa20067def11824a038913f0456719577b",
"md5": "1bbdfe9085f6c69212a7573346ddad2c",
"sha256": "bf5f912cdd668c2d8bda2ba81259a55b7ed4e2fdcccdaace1f9d651c0bae91b8"
},
"downloads": -1,
"filename": "mkdocs_bulma_classes_plugin-1.0.0b7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1bbdfe9085f6c69212a7573346ddad2c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<4.0",
"size": 6409,
"upload_time": "2023-02-10T12:36:55",
"upload_time_iso_8601": "2023-02-10T12:36:55.401533Z",
"url": "https://files.pythonhosted.org/packages/23/2c/f7fef161fcfa26d1b0bb7dc9b6aa20067def11824a038913f0456719577b/mkdocs_bulma_classes_plugin-1.0.0b7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "aaa107faa72d4c5f28df5552e0c13f6998f91c9bad52684961ecbc1e0771b05c",
"md5": "07f12d0951562635a66ce61bf869154a",
"sha256": "45aa07b62e7ffb94db411aec6bbc99c73599faaffe4112d999f72f12c12a0f23"
},
"downloads": -1,
"filename": "mkdocs_bulma_classes_plugin-1.0.0b7.tar.gz",
"has_sig": false,
"md5_digest": "07f12d0951562635a66ce61bf869154a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<4.0",
"size": 5346,
"upload_time": "2023-02-10T12:36:57",
"upload_time_iso_8601": "2023-02-10T12:36:57.041537Z",
"url": "https://files.pythonhosted.org/packages/aa/a1/07faa72d4c5f28df5552e0c13f6998f91c9bad52684961ecbc1e0771b05c/mkdocs_bulma_classes_plugin-1.0.0b7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-10 12:36:57",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "mkdocs-bulma-classes-plugin"
}
JSON