summaryrefslogtreecommitdiff
path: root/extendedimage.py
diff options
context:
space:
mode:
Diffstat (limited to 'extendedimage.py')
-rw-r--r--extendedimage.py11
1 files changed, 11 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 ![alt text](src.img title_text) image format in Markdown, but with two extra parameters.
+
+Usage:
+![alt text](src.img title_text href figcapture)
+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