diff options
| -rw-r--r-- | extendedimage.py | 11 | ||||
| -rw-r--r-- | headinginjector.py | 6 | ||||
| -rw-r--r-- | strikethrough.py | 6 |
3 files changed, 23 insertions, 0 deletions
diff --git a/extendedimage.py b/extendedimage.py index b62f100..27c2668 100644 --- a/extendedimage.py +++ b/extendedimage.py @@ -1,3 +1,14 @@ +""" +Like the standard  image format in Markdown, but with two extra parameters. + +Usage: + +href: if not empty, encapsulates image in <a> with the specified url +figcapture: if not empty, encapsulates image in a <figure> with the specified figcapture + +ALL PARAMETERS ARE MANDATORY! +Parameters can be encapsulated in double-quotes. Use "" for empty parameter. +""" from marko import inline from marko.helpers import MarkoExtension diff --git a/headinginjector.py b/headinginjector.py index 50ef606..cb1b5ca 100644 --- a/headinginjector.py +++ b/headinginjector.py @@ -1,3 +1,9 @@ +""" +Prefixes headers with the specified string. + +Usage: +MyExtension = get_heading_injector(prefix) +""" import marko.block from marko.helpers import MarkoExtension diff --git a/strikethrough.py b/strikethrough.py index a3f8c50..d0342fc 100644 --- a/strikethrough.py +++ b/strikethrough.py @@ -1,3 +1,9 @@ +""" +Encapsulates text in <del> html tag, which usually displayed as strikethrough text. + +Usage: +~~my text~~ +""" from marko import inline from marko.helpers import MarkoExtension |