From 76de6af40b80575019425607b3a9c2e126aaa332 Mon Sep 17 00:00:00 2001
From: Botond Hende <nettingman@gmail.com>
Date: Mon, 15 Jul 2024 23:44:45 +0200
Subject: added documents for extensions

---
 extendedimage.py | 11 +++++++++++
 1 file changed, 11 insertions(+)

(limited to 'extendedimage.py')

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
 
-- 
cgit v1.2.3-70-g09d2