Metadata-Version: 2.1
Name: markdown_code_blocks
Version: 3.0.0
Summary: Generate html from markdown with code-block highlighting
Home-page: https://github.com/asottile/markdown-code-blocks
Author: Anthony Sottile
Author-email: asottile@umich.edu
License: MIT
Description: [![Build Status](https://dev.azure.com/asottile/asottile/_apis/build/status/asottile.markdown-code-blocks?branchName=master)](https://dev.azure.com/asottile/asottile/_build/latest?definitionId=45&branchName=master)
        [![Azure DevOps coverage](https://img.shields.io/azure-devops/coverage/asottile/asottile/45/master.svg)](https://dev.azure.com/asottile/asottile/_build/latest?definitionId=45&branchName=master)
        [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/asottile/markdown-code-blocks/master.svg)](https://results.pre-commit.ci/latest/github/asottile/markdown-code-blocks/master)
        
        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
        
        `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
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.6.1
Description-Content-Type: text/markdown
