Skip to main content

Markdown loader for static API generator

Project description

Build Status Coverage Status Python versions PyPi

Implementation of BaseLoader from static API generator for converting content of markdown files to html content.

This loader support parsing of metadata like original BaseLoader.

Usage examples

from static_api_generator.generator import APIGenerator
from markdown_loader import MdLoader


api_gen = APIGenerator('/home/user/some_text_files/', '/home/user/static_api/', MdLoader)
api_gen.generatre()

Markdown files located in /home/user/some_text_files/ will be written as json to a directory /home/user/static_api/ with the hierarchy saved.

If the source text file looks like this

---
title: What is Lorem Ipsum?
category: Lorem Ipsum
...
Lorem Ipsum is simply dummy text of the printing and typesetting industry.

then the conversion result will be

{
    "title": "What is Lorem Ipsum?",
    "category": "Lorem Ipsum",
    "content": "<p>Lorem Ipsum is simply dummy text of the printing and typesetting industry.</p>"
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for static-api-generator-md-loader, version 0.0.5
Filename, size File type Python version Upload date Hashes
Filename, size static-api-generator-md-loader-0.0.5.tar.gz (2.2 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page