Lines Matching full:markdown

3 # Using Markdown as a Python Library
5 First and foremost, Python-Markdown is intended to be a python library module
6 used by various projects to convert Markdown syntax into HTML.
10 To use markdown as a module:
13 import markdown
14 html = markdown.markdown(your_text_string)
19 Python-Markdown provides two public functions ([`markdown.markdown`](#markdown)
20 and [`markdown.markdownFromFile`](#markdownFromFile)) both of which wrap the
21 public class [`markdown.Markdown`](#Markdown). If you're processing one
24 instance of the `markdown.Markdown` class and pass multiple documents through
28 ### markdown.markdown(text [, **kwargs]) {: #markdown data-toc-label='markdown.markdown' }  hashtag
30 The following options are available on the `markdown.markdown` function:
37 …Python-Markdown expects a **Unicode** string as input (some simple ASCII binary strings *may* work…
44             html = markdown.markdown(text)
56     Python-Markdown provides an [API](extensions/api.md) for third parties to
58     syntax. A few commonly used extensions are shipped with the markdown
74     of `markdown.extensions.Extension` and any configuration options should be
79         from markdown.extensions import Extension
83         markdown.markdown(text, extensions=[MyExtClass(option='value')])
96         markdown.markdown(text, extensions=['myext'])
112         markdown.markdown(text, extensions=['path.to.module:MyExtClass'])
160     extension by Markdown.
180 ### `markdown.markdownFromFile (**kwargs)` {: #markdownFromFile data-toc-label='markdown.markdownFr…
182 With a few exceptions, `markdown.markdownFromFile` accepts the same options as
183 `markdown.markdown`. It does **not** accept a `text` (or Unicode) string.
215         takes place in Python-Markdown. If this rather naive solution does not
219 ### markdown.Markdown([**kwargs]) {: #Markdown data-toc-label='markdown.Markdown' }  hashtag
221 The same options are available when initializing the `markdown.Markdown` class
222 as on the [`markdown.markdown`](#markdown) function, except that the class does
228     Instances of the `markdown.Markdown` class are only thread safe within
232 #### Markdown.convert(source) {: #convert data-toc-label='Markdown.convert' }
235 argument of the [`markdown.markdown`](#markdown) function.
241 md = markdown.Markdown()
261 #### Markdown.convertFile(**kwargs) {: #convertFile data-toc-label='Markdown.convertFile' }
264 name on the `markdown.markdownFromFile` function ([`input`](#input),