Skip to main content

A Markdown to HTML converter with generated TOC based on headings

Project description

CircleCI PyPI version semantic-release PyPI license Documentation Status Code style: black Downloads

Markdown to HTML

Markdown to HTML converter. Converts a Markdown file into an HTML file formed of two columns:

  • TOC (left-column)
    • An auto generated Table of Contents based in the markdown headings
  • Markdown content (right-column)

example

Install

  1. Create virtualenv.
python3 -m venv ~/.virtualenvs/markhtml
  1. Activate venv.
source ~/.virtualenvs/markhtml/bin/activate
  1. Install requirements.
pip install -r requirements.txt

Usage

To convert example.md using src/markhtml.py path-to-markdown-file.md generates example.html

src/markhtml.py examples/example.md
Generated file: examples/example.html

Notes

Uses python-markdown with TOC extension.

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

markhtml-0.0.1.tar.gz (4.5 kB view hashes)

Uploaded Source

Built Distribution

markhtml-0.0.1-py3-none-any.whl (4.6 kB view hashes)

Uploaded 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