Skip to main content

Adds CSS classes to html tags in Pelican documents

Project description

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.

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pelican-add-css-classes-1.0.4.tar.gz (4.2 kB view details)

Uploaded Source

Built Distribution

pelican_add_css_classes-1.0.4-py3-none-any.whl (4.3 kB view details)

Uploaded Python 3

File details

Details for the file pelican-add-css-classes-1.0.4.tar.gz.

File metadata

  • Download URL: pelican-add-css-classes-1.0.4.tar.gz
  • Upload date:
  • Size: 4.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/0.12.17 CPython/3.7.5 Darwin/18.7.0

File hashes

Hashes for pelican-add-css-classes-1.0.4.tar.gz
Algorithm Hash digest
SHA256 d021fd293323d68fd53bb00e7a14f25674d77b6d14efef514ea57482a8d95fda
MD5 463dccb259bec1f421dc1e7e1943aeb9
BLAKE2b-256 020ebb2dfd93873d12d8edad29f30098342255646975f8ed2408a113aff07004

See more details on using hashes here.

File details

Details for the file pelican_add_css_classes-1.0.4-py3-none-any.whl.

File metadata

File hashes

Hashes for pelican_add_css_classes-1.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 64e51645880638207b402c6fd08a8286bf0db8f5a055bf0561b2d19ce79445a9
MD5 d4b7d6cf07f99c5450e3a2811df0fa1e
BLAKE2b-256 036815f96fa04d2c649fff945289a8a447da261d14e287274536c858e82184fc

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page