https://github.com/asottile/markdown-code-blocks

Generate html from markdown with code-block highlighting
https://github.com/asottile/markdown-code-blocks

Last synced: 11 days ago
JSON representation

Generate html from markdown with code-block highlighting

• Host: GitHub
• URL: https://github.com/asottile/markdown-code-blocks
• Owner: asottile
• License: mit
• Created: 2017-03-14T04:21:23.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2024-10-22T00:30:44.000Z (22 days ago)
• Last Synced: 2024-10-26T11:51:46.420Z (18 days ago)
• Language: Python
• Size: 222 KB
• Stars: 4
• Watchers: 2
• Forks: 7
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![build status](https://github.com/asottile/markdown-code-blocks/actions/workflows/main.yml/badge.svg)](https://github.com/asottile/markdown-code-blocks/actions/workflows/main.yml)

[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/asottile/markdown-code-blocks/main.svg)](https://results.pre-commit.ci/latest/github/asottile/markdown-code-blocks/main)

markdown-code-blocks

====================

A stupid simple bit of code which combines [mistune][mistune] and

[pygments][pygments] to convert markdown into html.  Very similar to github

markdown, but for python.

## Installation

```bash

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][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:

```css

.highlight .gi { color: #070; }

.highlight .gd { color: #911; }

```

[mistune]: https://github.com/lepture/mistune

[pygments]: http://pygments.org/

[pygments-css]: https://github.com/richleland/pygments-css