Skip to main content

Generate html from markdown with code-block highlighting

Project description

Build Status Azure DevOps coverage pre-commit.ci status

markdown-code-blocks

A stupid simple bit of code which combines mistune and pygments to convert markdown into html. Very similar to github markdown, but for python.

Installation

pip install markdown-code-blocks

Usage

The library provides a single function highlight which takes in a markdown string and returns html.

You can also use the cli markdown-code-blocks-highlight. It optionally takes a single filename (defaulting to stdin) and writes to stdout.

For example:

markdown-code-blocks-highlight f.md > f.htm

pygments css

I'd suggest grabbing a theme file from pygments-css (or any other provider of pygments themes -- if you google there's a bunch of them).

This library will use the class .highlight so be sure to change out whatever class the theme uses with that.

Most themes (for whatever reason) don't add styles for diff display. I usually do something like this:

.highlight .gi { color: #070; }
.highlight .gd { color: #911; }

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

markdown_code_blocks-3.1.0.tar.gz (3.6 kB view hashes)

Uploaded Source

Built Distribution

markdown_code_blocks-3.1.0-py2.py3-none-any.whl (4.0 kB view hashes)

Uploaded Python 2 Python 3

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