Skip to content

matthewgreene/markdown_builder

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

markdown_builder

Simple Python package for creating Markdown documents in code.

Currently supported Markdown Elements (more to come!)

  • Headers
  • Lists
    • Checkbox
    • Ordered
    • Unordered
  • Tables
  • Paragraphs
  • Links

Examples

To start building Markdown documents in code, we must first create a MarkdownBuilder instance.

md = MarkdownBuilder()

This serves as the entrypoint for all Markdown elements to be added to the document. From here we begin adding new elements.

Headers

md.addHeader(level=1, text="Test Header")

The above command will generate to following syntax:

# Test Header

Lists

md = MarkdownBuilder()
uol = UnorderedList(["one", "two", UnorderedList(["four", "five"]), "three"])
md.addList(uol)

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

No packages published