Skip to main content

MD to HTML converter

Project description

Markdown to HTML Converter

This is a converter from Markdown to HTML with advanced support for Markdown tables and GFM syntax highlighting. This package relies on markdown2 for converting basic Markdown to HTML and pygments to support code to HTML conversion for syntax highlighting. The default (and, currently, only) theme for this package is Monokai.

You can find a sample of a site generated from this package at https://mcautograder.cpyles.com.

Installation

The converter is installed using pip:

pip install md2html

Usage

This package an executable that can be run from the command line:

md2html ...

Here is the help entry for this file:

usage: md2html [-h] [-s SITE] [-n NAV] ...

convert Markdown to HTML

positional arguments:
  files                 files to be converted to HTML

optional arguments:
  -h, --help            show this help message and exit
  -s SITE, --site-info SITE
                        add metadata to the HTML files
  -n NAV, --nav NAV     add a YAML file to use for navigation menu

Running the converter will place HTML files in the same directory as your Markdown files, with the .md extension replaced with .html. The HTML files come with CSS in a style tag in the head.

Page Metadata

If you would like to add metadata to your page, including a navigation menu, do so by creating a YAML file containing this metadata and passing the file path to the -s flag, e.g.

md2html -s meta.yml ...

The structure of your YAML file should be:

title: page title
author: page author
description: page description
navigation:
  nav_title: navigation menu title
  links:
    - title: link name
      url: HTML file path
    - title: ...
      url: ...
    ...

Currently, the title must be set if you use this option. The converter does not yet support navigation submenus, so all links will be rendered as

Navigation Menu

The converter also supports adding only a navigation menu without page metadata. To do this, pass a YAML file to the -n flag. It should have the following structure:

nav_title: navigation menu title
links:
  - title: link name
    url: HTML file path
  - title: ...
    url: ...
  ...

Changelog

v1.1"

  • Added docstrings for documentation
  • Moved some utils out of md2html/converter.py

v1.0:

  • Changed to Boostrap CSS

v0.1:

  • Initial release

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

md2html-1.1.tar.gz (7.2 kB view details)

Uploaded Source

Built Distribution

md2html-1.1-py3-none-any.whl (17.2 kB view details)

Uploaded Python 3

File details

Details for the file md2html-1.1.tar.gz.

File metadata

  • Download URL: md2html-1.1.tar.gz
  • Upload date:
  • Size: 7.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.5

File hashes

Hashes for md2html-1.1.tar.gz
Algorithm Hash digest
SHA256 fe3f6e53411b8457fed997714f0297d6db0322861a4a5c1ac0d44309db3df499
MD5 ca612ee79d9fcc6389a3db5debe49f46
BLAKE2b-256 9ca6d024c880fe0a75400f2e3eca8c1e54da2d3e3f7853c337e37656288e60d6

See more details on using hashes here.

File details

Details for the file md2html-1.1-py3-none-any.whl.

File metadata

  • Download URL: md2html-1.1-py3-none-any.whl
  • Upload date:
  • Size: 17.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.5

File hashes

Hashes for md2html-1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a99d077f48be125dd17e037187ca89793e3b505dbb5158c3cf81aa7ef05a0892
MD5 2fe19fa5a013ea846585ebcba5645ecf
BLAKE2b-256 3b32c802620c20852da17583ba5999f4137ae2a24dc1b9a1ba4a350e024c09cf

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page