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 dacomment
• Resolutions -{bad wolf}(STET)
• Metadata:
  • Comments on all types in parentheses after oldnewcomment etc
  • Attribution in parentheses in comment newcommentCommenter
  • Date with attribution oldcommentCommenter2020-04-21
  • Comment as footnote la de da^note ... (^note): comment
  • Comments can contain markup la de dasome *markup*

This is a new addition

This this word is removed

I say, out with the oldin with the new

Here just a comment is a line with a comment

You can also add comments to some textLike this

All newRedundantMakyo edit marks can have comments with attributions and dates like thisSee?Makyo2020-04-22 (though it's ignored with comments like this)

Text after

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