Skip to main content

This is a light-weighted, purly python made markdown parser and render

Project description

markdown

Build Status

Upload Python Package A learn-motivated markdown parser.

Supports all standard md elements.

Sample use case:

Install:

pip install lightmd

Parse md.

import lightmd

with open("your.md", "r") as md_file:
    ## Parse content
    parsed_content = lightmd.parse_md_to_ast(md_file.read())
    ## Render to HTML
    rendered_html = lightmd.render_html(parsed_content)
    ## Render to HTML with custom css style
    rendered_html = lightmd.render_html(parsed_content, "/path/to/css_style.css")

Dev onboarding

Install Python 3.7

For Mac OS:

brew install python@3.7

For Windows User:

choco install python --version=3.7

Create Virtual Enviroment

run following command to install pipenv

pip install pipenv

Restart your command-line console, run following command:

cd [project dir]
pipenv shell

Install all dependencies

pipenv install

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

lightmd-0.0.2.0.tar.gz (11.1 kB view hashes)

Uploaded Source

Built Distribution

lightmd-0.0.2.0-py3-none-any.whl (31.3 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