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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file markhtml-0.0.1.tar.gz.

File metadata

  • Download URL: markhtml-0.0.1.tar.gz
  • Upload date:
  • Size: 4.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.56.2 CPython/3.6.8

File hashes

Hashes for markhtml-0.0.1.tar.gz
Algorithm Hash digest
SHA256 e4a061d94e585086d1862da7a11d275bcc54c77a915e9819da6b94a655aed8c2
MD5 7c268d3700b8cf1c3dd032ea6c34b11b
BLAKE2b-256 765ea7bbae3a1ecb6bf31b2ec22ce5c4a4146ac26a3138f2cd15653a275153b3

See more details on using hashes here.

File details

Details for the file markhtml-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: markhtml-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 4.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.56.2 CPython/3.6.8

File hashes

Hashes for markhtml-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 75198858acae37eaceb99648958f55a7c07f44bbfbbc786e91d7de5bc6bb995e
MD5 8f8273e998fd722f98b081f027b26dfe
BLAKE2b-256 1ad638dd28f26eeb2a6d36f1d6fc77e9e043ec43152f22e28bad4caade23d67f

See more details on using hashes here.

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