Lines Matching full:markdown
3 # Writing Extensions for Python-Markdown
5 Python-Markdown includes an API for extension writers to plug their own custom functionality and sy…
27 Preprocessors munge the source text before it is passed to the Markdown parser. This is an excellen…
30 Preprocessors inherit from `markdown.preprocessors.Preprocessor` and implement a `run` method, whic…
39 from markdown.preprocessors import Preprocessor
56 Some preprocessors in the Markdown source tree include:
66 [c1]: https://github.com/Python-Markdown/markdown/blob/master/markdown/preprocessors.py
67 [c2]: https://github.com/Python-Markdown/markdown/blob/master/markdown/preprocessors.py
68 [c3]: https://github.com/Python-Markdown/markdown/blob/master/markdown/preprocessors.py
69 [c4]: https://github.com/Python-Markdown/markdown/blob/master/markdown/extensions/meta.py
70 [c5]: https://github.com/Python-Markdown/markdown/blob/master/markdown/extensions/footnotes.py
75 …k lines, may have a different syntax and produce a differently structured tree than other Markdown.
78 Block processors inherit from `markdown.blockprocessors.BlockProcessor`, are passed `md.parser` on …
109 `BlockParser`, not to be confused with `BlockProcessor`, is the class used by Markdown to cycle thr…
126 For perspective, Markdown calls `parseDocument` which calls `parseChunk` which calls `parseBlocks` …
206 Some block processors in the Markdown source tree include:
215 [b1]: https://github.com/Python-Markdown/markdown/blob/master/markdown/blockprocessors.py
216 [b2]: https://github.com/Python-Markdown/markdown/blob/master/markdown/blockprocessors.py
217 [b3]: https://github.com/Python-Markdown/markdown/blob/master/markdown/blockprocessors.py
218 [Admonition]: https://python-markdown.github.io/extensions/admonition/
219 [b4]: https://github.com/Python-Markdown/markdown/blob/master/markdown/extensions/admonition.py
226 A tree processor must inherit from `markdown.treeprocessors.Treeprocessor` (note the capitalization…
241 from markdown.treeprocessors import Treeprocessor
254 Additional tree processors in the Markdown source tree include:
263 [e1]: https://github.com/Python-Markdown/markdown/blob/master/markdown/treeprocessors.py
264 [e2]: https://github.com/Python-Markdown/markdown/blob/master/markdown/extensions/toc.py
265 [e3]: https://github.com/Python-Markdown/markdown/blob/master/markdown/extensions/footnotes.py
266 [e4]: https://github.com/Python-Markdown/markdown/blob/master/markdown/extensions/footnotes.py
267 [table of contents]: https://python-markdown.github.io/extensions/toc/
268 [footnote]: https://python-markdown.github.io/extensions/footnotes/
281 …* `md`, an optional parameter, is a pointer to the instance of `markdown.Markdown` and is availabl…
311 from markdown.inlinepatterns import InlineProcessor
312 from markdown.extensions import Extension
364 create a `strong` element. Therefore, Markdown provides a number of generic `InlineProcessor` subcl…
367 subclasses found at `markdown.inlinepatterns`.
370 from markdown.inlinepatterns import SimpleTagInlineProcessor
371 from markdown.extensions import Extension
390 [i1]: https://github.com/Python-Markdown/markdown/blob/master/markdown/inlinepatterns.py
391 [i2]: https://github.com/Python-Markdown/markdown/blob/master/markdown/inlinepatterns.py
392 [i3]: https://github.com/Python-Markdown/markdown/blob/master/markdown/inlinepatterns.py
393 [i4]: https://github.com/Python-Markdown/markdown/blob/master/markdown/inlinepatterns.py
394 [i5]: https://github.com/Python-Markdown/markdown/blob/master/markdown/inlinepatterns.py
395 [i6]: https://github.com/Python-Markdown/markdown/blob/master/markdown/extensions/abbr.py
396 [i7]: https://github.com/Python-Markdown/markdown/blob/master/markdown/extensions/wikilinks.py
397 [i8]: https://github.com/Python-Markdown/markdown/blob/master/markdown/extensions/footnotes.py
401 In version 3.0, a new, more flexible inline processor was added, `markdown.inlinepatterns.InlinePro…
402 original inline patterns, which inherit from `markdown.inlinepatterns.Pattern` or one of its childr…
423 Inline Patterns can implement inline HTML element syntax for Markdown such as `*emphasis*` or
425 `markdown.inlinepatterns.Pattern` or one of its children. Each pattern object uses a single regular…
448 from markdown.inlinepatterns import Pattern
458 As discussed in [Integrating Your Code Into Markdown][], an instance of this class will need to be …
459 Markdown. That instance would be created like so:
474 Postprocessors inherit from `markdown.postprocessors.Postprocessor` and implement a `run` method wh…
483 from markdown.postprocessors import Postprocessor
494 Some postprocessors in the Markdown source tree include:
503 [p1]: https://github.com/Python-Markdown/markdown/blob/master/markdown/postprocessors.py
504 [p2]: https://github.com/Python-Markdown/markdown/blob/master/markdown/postprocessors.py
505 [p3]: https://github.com/Python-Markdown/markdown/blob/master/markdown/postprocessors.py
506 [p4]: https://github.com/Python-Markdown/markdown/blob/master/markdown/extensions/footnotes.py
511 As mentioned, the Markdown parser converts a source document to an [ElementTree][ElementTree] objec…
512 serializing that back to Unicode text. Markdown has provided some helpers to ease that manipulation…
513 of the Markdown module.
525 from markdown.util import AtomicString
537 td1.text = markdown.util.AtomicString("Cell content") # Add plain text content
573 For the global `htmlStash` instance to be available from a processor, the `markdown.Markdown` insta…
576 ## Integrating Your Code Into Markdown {: #integrating_into_markdown }
578 Once you have the various pieces of your extension built, you need to tell Markdown about them and …
579 are run in the proper sequence. Markdown accepts an `Extension` instance for each extension. Theref…
580 to define a class that extends `markdown.extensions.Extension` and over-rides the `extendMarkdown` …
582 Markdown instance.
586 …ous types of processors and patterns are stored within an instance of the `markdown.Markdown` class
593 The `extendMarkdown` method of a `markdown.extensions.Extension` class accepts one argument:
597 A pointer to the instance of the `markdown.Markdown` class. You should use this to access the
606 Some other things you may want to access on the `markdown.Markdown` instance are:
620 …ing][] techniques. However, you should be aware that the various undocumented parts of Markdown may
622 doing is inserting processors and patterns into the Markdown pipeline. Consider yourself warned!
629 from markdown.extensions import Extension
639 Some extensions may need to have their state reset between multiple runs of the `markdown.Markdown`…
643 md = markdown.Markdown(extensions=['footnotes'])
662 Then, each time `reset` is called on the `markdown.Markdown` instance, the `reset` method of each r…
669 `self.config` of your `markdown.extensions.Extension` class in the following format:
672 class MyExtension(markdown.extensions.Extension):
685 markdown.Markdown(extensions=[MyExtension(option1='other value')])
690 The `markdown.extensions.Extension` class and its subclasses have the following methods available t…
719 …e [library reference] an instance of an extension can be passed directly to `markdown.Markdown`. In
725 import markdown
727 md = markdown.Markdown(extensions=[MyExtension(option='value')])
730 However, Markdown also accepts "named" third party extensions for those occasions when it is imprac…
737 points. Python-Markdown extensions must be assigned to the `markdown.extensions` group. An entry po…
746 'markdown.extensions': ['myextension = path.to.module:MyExtension']
755 markdown.markdown(text, extensions=['myextension'])
758 … more entry points within the same group are assigned the same name, Python-Markdown will only ever
779 markdown.markdown(text, extensions=['path.to.module:MyExtension'])
793 class MyExtension(markdown.extensions.Extension)
800 When `markdown.Markdown` is passed the "name" of your extension as a dot notation string that does …
806 The `markdown.util.Registry` class is a priority sorted registry which Markdown uses internally to …
842 `markdown.util.Registry` has the following methods:
869 [bug tracker]: https://github.com/Python-Markdown/markdown/issues
870 [extension source]: https://github.com/Python-Markdown/markdown/tree/master/markdown/extensions
871 [tutorial]: https://github.com/Python-Markdown/markdown/wiki/Tutorial-1---Writing-Extensions-for-Py…
873 [Integrating your code into Markdown]: #integrating_into_markdown
881 [Footnotes]: https://github.com/Python-Markdown/markdown/blob/master/markdown/extensions/footnotes.…
882 [Definition Lists]: https://github.com/Python-Markdown/markdown/blob/master/markdown/extensions/def…