Thanks to visit codestin.com
Credit goes to github.com

Skip to content

pugachAG/mdpy

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 

Repository files navigation

mdpy

mdpy is simple internal python domain-specific language for generating markdown documents.

# create markdown document
doc = MdDocument('mdpy')
# add H4 header to the document
# note that this header will be automatically added to the document table of contents  
doc.emplace_heading('H5 header example', 5)
# or you can explicitly specify if you want header to be added to the table of contents
doc.emplace_heading('This one will not be added to the content table', 5, False)
Column align center Column align left Column align right
1 To be, or not to be, that is the question Shakespeare
2 Wow, such alignment, very left Doge
# add table to the document
doc.add_content(
    # table definition
    MdTable(
        # column headers definitions
        ('Column align center', MdTableColumnAlignment.CENTER),
        ('Column align left', MdTableColumnAlignment.LEFT),
        ('Column align right', MdTableColumnAlignment.RIGHT))
        # add table entries (fluent interface)
    .add_entry(1, 'To be, or not to be, that is the question', 'Shakespeare')
    .add_entry(2, 'Wow, such alignment, very left', 'Doge')
)
  • List item 1
  • The second one
    • Nested list item 1
    • Nested list item 2
  • Outer list item 3
# add list to the document
doc.add_content(
    # list definition
    MdList()
    # add list items (fluent interface)
    .add_item('List item 1')
    .add_item('The second one')
    .add_item(
        # nested list definition
        MdList()
        .add_item('Nested list item 1')
        .add_item('Nested list item 2')
    )
    .add_item('Outer list item 3')
)
# save markdown document as README.md
doc.save('README.md')

MIT

About

Simple internal python domain-specific language for generating markdown documents

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages