Metadata-Version: 2.1
Name: pelican-add-css-classes
Version: 1.0.4
Summary: Adds CSS classes to html tags in Pelican documents
Home-page: https://github.com/johanvergeer/pelican-add-css-classes
License: MIT
Keywords: pelican,plugin
Author: Johan Vergeer
Author-email: johanvergeer@gmail.com
Requires-Python: >=3.6,<4.0
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Framework :: Pelican
Classifier: Framework :: Pelican :: Plugins
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Provides-Extra: markdown
Requires-Dist: beautifulsoup4 (>=4.8,<5.0)
Requires-Dist: markdown (>=3.1.1,<4.0.0); extra == "markdown"
Requires-Dist: pelican (>=4.2,<5.0)
Requires-Dist: toml (>=0.10.0,<0.11.0)
Project-URL: Repository, https://github.com/johanvergeer/pelican-add-css-classes
Description-Content-Type: text/markdown

# Add css classes: A Plugin for Pelican

Adds CSS classes to html tags in Pelican documents

## Motivation

When we want to create a page or article we often use Markdown or RST. This allows us to
write content very fast, but it gives us little to no control over the styling of our page.

That is why I created this plugin for Pelican so we can add classes to HTML elements 
inside `pelicanconf.py`.

## Usage

### Both pages and articles

To set css classes that should be added to elements in both 
pages and articles you can use `ADD_CSS_CLASSES`.

You can also set which css classes should be added to elements 
on pages with `ADD_CSS_CLASSES_TO_PAGE`.

And this can also be done with articles using `ADD_CSS_CLASSES_TO_ARTICLE`.

#### Example

Let's say you want to configure all tables to use Bootstrap, show black tables on pages 
and red headers on articles.

```python
ADD_CSS_CLASSES = {
    "table": ["table"]
}

ADD_CSS_CLASSES_TO_PAGE = {
    "table": ["table", "table-dark"]
}

ADD_CSS_CLASSES_TO_ARTICLE = {
    "h1": ["text-danger"]
}
```

Installation
------------

This plugin can be installed via:

    pip install pelican-add-css-classes

Contributing
------------

Contributions are welcome and much appreciated. Every little bit helps. You can contribute by improving the documentation, adding missing features, and fixing bugs. You can also help out by reviewing and commenting on [existing issues][].

To start contributing to this plugin, review the [Contributing to Pelican][] documentation, beginning with the **Contributing Code** section.

[existing issues]: https://github.com/johanvergeer/pelican-add-css-classes/issues
[Contributing to Pelican]: https://docs.getpelican.com/en/latest/contribute.html

