document how to use highlight mixin

lepture · Sep 7, 2018 · 477e19c · 477e19c
1 parent 323dea9
commit 477e19c
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/mistune_contrib/highlight.py b/mistune_contrib/highlight.py
@@ -36,6 +36,22 @@ def block_code(text, lang, inlinestyles=False, linenos=False):
 
 
 class HighlightMixin(object):
+    """Highlight mixin for Renderer, mix this with Renderer::
+
+        class HighlightRenderer(HighlightMixin, Renderer):
+            pass
+
+        highlight = HighlightRenderer()
+        highlight.options = {
+          "linenos": "inline",
+          "full": True,
+          #"inlinestyles": True,
+        }
+
+        md = mistune.Markdown(renderer=highlight)
+        html = md(md_txt)
+    """
+
     def block_code(self, text, lang):
         # renderer has an options
         inlinestyles = self.options.get('inlinestyles', False)