Skip to content

Latest commit

 

History

History
121 lines (81 loc) · 2.72 KB

README.md

File metadata and controls

121 lines (81 loc) · 2.72 KB
Raw
title author description css
mdthtml
Chris Magyar
Commonmark-plus flavored markdown to html parser.
css/main.css

Markdown parser with extras built in. This project is a bunch of additions to markdown-it-py. It's kind of hacky right now, but it works alright for my purposes.

Installation

This is beta-alpha right now so it ain't on PyPI yet. Clone this repo and build/run/install manually.

Build python package:

$ python -m build

Build package, install in a virtual environment, and run all tests:

$ make test

Python API Usage

from mdthtml import MarkdownHTML

text = ("""---
title: Test Document
author: mags
---

# Heading

Some code:

    sudo mount /dev/sda2 /mnt/nas
""")

mdhtml = MarkdownHTML()
mdhtml.parse(text)
print(mdhtml.html)

Command Line Usage

Accepts stdin and/or a list of files. Outputs to stdout or a single file.

mdthtml [OPTION...] [FILE...]

Options

-c, --css <PATH>
    Add link to css stylesheet. PATH does not necessarily need to exist.

-R, --relative

    Calculate css path relative to first FILE.

-f, --template-file <FILE>
    Template file.

-o, --output <FILE>
    Output to file.

-O, --auto
    Automatically name output file based on last file supplied.

-t, --title <TITLE>
    Title to include in head, overrides any metadata in document.

-B, --body-only
    Output html body content only. ('{content}' as template string)

-M, --meta-only
    Output html meta content only. ('{metatdata}' as template string)

-J, --json
    Output json.

-T, --tree
    Output token tree.

-Y, --yes
    Overwrite output file.

-h
    Print short help.

-H, --help
    Print help.

Features

Commonmark standard (gfm tables) as parsed by markdown-it-py plus some hacky additions:

  • add id tags to every heading element
  • parse front-matter and back-matter for metadata
  • customized code blocks (make PS1 prompt its own span for styling)

Features Roadmap

  • table of contents (customized names, not just a copy of heading content)
  • banner ascii figlet content
  • syntax highlighting
  • images, galleries

Ideas/Directions

I'd like to make any additional markdown syntax I implement also be as compatible as possible with more standard markdown parsers (e.g. github's markdown parser). Then one won't have to write different/separate markdown for these platforms. One simple way to do this is by using html comments to add content/metadata.

I could write plugins and/or parse content after/before passing to markdown-it-py. Writing plugins is probably the way to go, although some things may not be possible with plugins alone.