Zk | Editing Markdown Extension

tech markdown vimwiki python package

What it does

I want to be able to have editing comments in Markdown, so I came up with some extensions to the syntax. The goal should be for the text to still be at least mostly readable.

• Additions new text
• Deletions old text
• Substitutions oldnew
• Comments la de da
• Resolutions }(STET)
• Metadata:
  • Comments on all types in parentheses after oldnew etc
  • Attribution in parentheses in comment new
  • Date with attribution old
  • Comment as footnote la de da ... (^note): comment
  • Comments can contain markup la de da

She brushedstroked

her fingers softly along the edges of cabinet doors. Each }(STET (Makyo 2020-04-21)) was opened and inspected, leaving her standing on tiptoes to peer in those above the counters. Nothing but cups and glasses, plates and bowls, cutting boards and pots and pans and trays and dishes. All clean and neatly stacked.

(^note): Are you sure about this? Note at bottom of document (Makyo 2020-04-21)

How to use it

default_config = {
    'tag_tuple': ('<div class="verse">', '</div>'),
}
my_config = {
    'tag_tuple': ('<verse>', '</verse>'),
}
markdown(source, extensions=[VerseExtension(**my_config)])

Where to get it

• PyPI
• Github