aboutsummaryrefslogtreecommitdiffstats
path: root/docs/reference.txt
Commit message (Collapse)AuthorAgeFilesLines
* Switch docs to MKDocs (#602)Waylan Limberg2017-12-061-325/+0
| | | | | | | | | | | | | | | | | | | | | | | | Fixes #601. Merged in 6f87b32 from the md3 branch and did a lot of cleanup. Changes include: * Removed old docs build tool, templates, etc. * Added MkDocs config file, etc. * filename.txt => filename.md * pythonhost.org/Markdown => Python-Markdown.github.io * Markdown lint and other cleanup. * Automate pages deployment in makefile with `mkdocs gh-deploy` Assumes a git remote is set up named "pages". Do git remote add pages https://github.com/Python-Markdown/Python-Markdown.github.io.git ... before running `make deploy` the first time.
* Fox formatting of extension_configs example.Waylan Limberg2016-11-171-7/+3
| | | Fixes #511. Thanks to @omiday for the report.
* Fix lazy ordered list example in documentationsblondon2016-03-301-2/+2
| | | | | | | | | | | | | | | The documentation is not accurate when lazy_ol=False parameter is called. The example shows the 'start' attribute to the first <li> tag. However, the attribute is in the <ol> tag: >>> import markdown >>> s = """ ... 4. Apples ... 5. Oranges ... 6. Pears""" >>> markdown.markdown(s, lazy_ol=False) u'<ol start="4">\n<li>Apples</li>\n<li>Oranges</li>\n<li>Pears</li>\n</ol>' The behaviour of the library is the correct one (https://developer.mozilla.org/fr/docs/Web/HTML/Element/ol), so the documentation need to be fixed, not the library.
* Thorough spell check of the docs.Waylan Limberg2015-02-071-17/+17
|
* Mark "Safe Mode" as pending deprecation.Waylan Limberg2014-09-011-15/+18
| | | | | Both `safe_mode` and `html_replacement_test` keywords are pending deprecation, as are positional args. Closes #337.
* Some docs cleanup.Waylan Limberg2014-08-291-5/+6
|
* Mark special treatment of extension names as PendingDeprecationWaylan Limberg2014-08-291-19/+23
| | | | | | | | | | | | | | | | | The builtin extensions will no longer get special treatment and have the path ("markdown.extensions.") appended . The same applies for "mdx_" extensions. All names extension must provide the full path. Fixes #336. Also deprecating support for passing in extension config settings as part of the string name. The extension_configs keyword should be used instead. Fixes #335. Also raising PendingDeprecationWarnings for positional args or the "config" keyword on the Extension Class. Pass each setting as a seperate keyword instead. Docs and tests are updated. Still need to update extension API docs.
* Update lib reference docs to reflect that extension_configs accepts dicts. ↵Waylan Limberg2014-08-201-10/+14
| | | | Related to #325
* Update reference docs for recent Extension.__init__ refactor.Waylan Limberg2014-08-011-3/+13
| | | Noted that using keywords it the prefered method of passing config options to extensions. Also updated the example sto demonstrate the new prefered way as discussed in #325.
* Emphasized proper use of reset method in docs.John Sullivan2014-04-191-5/+8
| | | | This is related to waylan/Python-Markdown#305.
* Fix typo in reference.txtMartin Maillard2014-03-031-1/+1
|
* typoMark Eichin2014-02-111-1/+1
| | | chaining calls, not changing calls
* Update reference.txtWaylan Limberg2013-10-231-1/+1
| | | Fixed #261. Thanks for the report @mpvharmelen.
* Various changes to docs for updated changes, clarity, and to fix typos.Waylan Limberg2013-02-191-31/+50
|
* Updated docs to reflect extension loading best practices.Waylan Limberg2013-02-081-14/+50
| | | | Fixes #184. Also delted some commented out code I missed in previous commit.
* Misc typos.chri2012-08-281-2/+2
|
* Updated docs to reflect fix in #82.Waylan Limberg2012-05-031-4/+9
|
* Typo fix in doc: s/extension-configs/extension_configs/Simon Sapin2012-03-191-2/+2
|
* Added siteindex to docs.Waylan Limberg2012-03-071-2/+2
|
* Rename docs/*.md => docs/*.txtWaylan Limberg2012-03-071-0/+244
The documentation uses features of Python-Markdown that are not supported on GitHub and it's better to get a source view of the docs anyway. For example, that way comments and bug reports can reference a specific line of a file. Of course, it makes sense for Github to render the README, so that is left with the `.md` file extension.
generated by cgit v1.2.3 (git 2.25.1) at 2024-12-23 07:12:30 +0000