Skip to main content

Decorate HTML docs by adding them classes by theme

Project description

Tests Travis results Coveralls results_
Downloads Last month downloads from pypi Last week downloads from pypi Yesterday downloads from pypi
About License Wheel Python versions Python interpreters
Status Status Status

About Decorate

Decorate takes an HTML and decorates it with style.

Currently it just support Bootstrap, but it is built in order to allow any other framework.

MDL (Material Design Lite) current support is very poor.

How does it work

It parses the HTML, uses a set of rules and creates a new HTML with new classes.

You can say: “Well… I could have done the same by using JavaScript”, and you’d right. But there are some advantages in using it statically:

  • It is faster. You have just to run it once.
  • It can be used in third parties projects. Forget about the style from now on.
  • Avoids the blink while javascript is being applied.

What was it intended for?

I was writting a static test runner, and I decided not to tie it to any style. This was a spin off. Indeed, it could be run as command line…

Usage

Command line

Please, run the help command with -h.

Here you are a basic example:

decorate my.html -t bootstrap -o output

Library

Easy: just import and use it:

from decorate import Decorate
decorate = Decorate('bootstrap')
with open('my.html') as fd:
  decorate.apply_to(fd.read(), 'output.html')

Project details


Download files

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

Files for decorate, version 1.0.1
Filename, size & hash File type Python version Upload date
decorate-1.0.1-py3-none-any.whl (9.1 kB) View hashes Wheel 3.5

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page