diff options
| author | Waylan Limberg <waylan.limberg@icloud.com> | 2014-08-20 15:02:28 -0400 |
|---|---|---|
| committer | Waylan Limberg <waylan.limberg@icloud.com> | 2014-08-20 15:02:28 -0400 |
| commit | 691d2918e7e9b23dfd9e98e78caa2b0ad611d690 (patch) | |
| tree | 6294fd9ecb520775b3ad8933877e5c7abd691ee6 /docs/reference.txt | |
| parent | 1918cd26a16bf6051b3fcc791e1f260bad846c72 (diff) | |
| download | markdown-691d2918e7e9b23dfd9e98e78caa2b0ad611d690.tar.gz markdown-691d2918e7e9b23dfd9e98e78caa2b0ad611d690.tar.bz2 markdown-691d2918e7e9b23dfd9e98e78caa2b0ad611d690.zip | |
Update lib reference docs to reflect that extension_configs accepts dicts. Related to #325
Diffstat (limited to 'docs/reference.txt')
| -rw-r--r-- | docs/reference.txt | 24 |
1 files changed, 14 insertions, 10 deletions
diff --git a/docs/reference.txt b/docs/reference.txt index 1b2ef11..033b658 100644 --- a/docs/reference.txt +++ b/docs/reference.txt @@ -123,16 +123,20 @@ The following options are available on the `markdown.markdown` function: The dictionary of configuration settings must be in the following format: - extension_configs = {'extension_name_1': - [ - ('option_1', 'value_1'), - ('option_2', 'value_2') - ], - 'extension_name_2': - [ - ('option_1', 'value_1') - ] - } + extension_configs = + { + 'extension_name_1': + { + 'option_1': 'value_1', + 'option_2': 'value_2' + }, + { + 'extension_name_2': + { + 'option_1': 'value_1' + } + } + See the documentation specific to the extension you are using for help in specifying configuration settings for that extension. |