aboutsummaryrefslogtreecommitdiffstats
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* docs: improved documentation of the extra/ extensionsJakub Klinkovský2014-02-157-78/+74
| | | | | | Simplified, unified style, added some undocumented options. NOTE: Footnotes/UNIQUE_IDS stays mostly undocumented
* Updated version 2.4 release notes.Dmitry Shachnev2014-02-133-5/+39
|
* typoMark Eichin2014-02-111-1/+1
| | | chaining calls, not changing calls
* Pedantic edit in installation instructionsJesper Öqvist2014-02-061-1/+1
| | | Fixed "you're"/"your" mixup. Sorry.
* Document hl_lines feature for fenced_code and codehilite extensions.A. Jesse Jiryu Davis2014-01-072-0/+36
|
* Fixed silly spelling errors.Waylan Limberg2014-01-011-6/+6
| | | Must remember to spellcheck everything I type.
* Updated footnote documentation for clarity.Waylan Limberg2014-01-011-8/+21
| | | This addresses a misunderstanding reported in issue #273. The behavior has not changed. The docs just better reflect the actual behavior better. Apparently using the word "definition" both for footnotes and definition lists was an unfortunate coincidence that created confusion. We now use the term "footnote content".
* Merge pull request #266 from ryneeverett/issue52Waylan Limberg2013-12-231-7/+5
|\ | | | | miscellaneous issue52 improvements
| * Miscellaneous improvements and bug fixes.ryneeverett2013-11-191-7/+5
| |
* | added missing 's' to wikilinks documentationColorado Reed2013-12-221-3/+2
|/
* Update reference.txtWaylan Limberg2013-10-231-1/+1
| | | Fixed #261. Thanks for the report @mpvharmelen.
* Issue #52ryneeverett2013-10-141-0/+96
|
* Mention new option in toc.txtDmitry Shachnev2013-09-291-0/+2
|
* Merge pull request #247 from vhf/patch-1Waylan Limberg2013-09-181-1/+1
|\ | | | | Typo fix
| * Typo fixvhf / victor felder2013-09-091-1/+1
| |
* | Clean trailing whitespaceAdam Dinwoodie2013-09-191-21/+21
| |
* | Correct documentation: `wikilink` -> `wikilinks`Adam Dinwoodie2013-09-191-6/+6
|/ | | | This fixes #250.
* Added release notes for pending release of v2.4.Waylan Limberg2013-08-133-4/+52
| | | | | Since adding the new smarty extension, the nex release it more than just a bugfix release.
* Add documentation for smarty extensionDmitry Shachnev2013-07-265-4/+63
|
* Improved codehilite docs. Document `css_class` setting.Waylan Limberg2013-06-161-5/+13
| | | | | | Also cleaned up poor wording on other setting for codehilite. Thanks for the inital suggestion @davidcorne. Fixes #223.
* Updated extension API docs to list output_format and serializer on the md ↵Waylan Limberg2013-05-091-6/+9
| | | | | | | | | instance. I still need to document everything on that list and probably a few things missing from the list. I also updated the warning about monkey patching to be a "Warning" admonition - now that we have that extension. Probably should depreciate access to md_globals in the extension API -- as we don't actually use any anymore. That dates back to pre-OO code.
* Added a note about tox in test suite docs.Waylan Limberg2013-03-191-1/+7
|
* Date release 2.3 in change_logWaylan Limberg2013-03-151-1/+1
|
* Updated testing framework to use PyTidyLib rather than uTidyLib for Python 3 ↵Waylan Limberg2013-03-131-6/+6
| | | | support.
* Removed html_tidy docs.Waylan Limberg2013-03-131-34/+0
|
* Removed the html_tidy extension. See 2.3 release notes for explaination.Waylan Limberg2013-03-135-11/+22
|
* Tweaked the docs some more.Waylan Limberg2013-02-276-56/+72
|
* Minor formatting edit to release notes for v2.3.Waylan Limberg2013-02-271-1/+1
|
* Updated release notes for v2.3. to reflect recent changes.Waylan Limberg2013-02-271-14/+32
|
* Better clarify the 4 space indentation rule.Waylan Limberg2013-02-211-7/+5
| | | A better explanation for #193 that includes all block-level elements nested in lists.
* Update docs/index.txtWaylan Limberg2013-02-211-0/+4
| | | | | | Clarify that strict 4 space indentation applies to nested lists.  Closes #193. Hopefully, people will read this in the docs before filing bug reports in the future. One can dream.
* Various changes to docs for updated changes, clarity, and to fix typos.Waylan Limberg2013-02-1913-160/+171
|
* Ensure toc attribute is available on Markdown class.Waylan Limberg2013-02-191-2/+19
| | | | | | This appears to have recently been broken with the fixes in #191. This time I've added tests to prevent future breakage and added documentation to explain the behavior.
* Allow better linenum override in CodeHiliteWaylan Limberg2013-02-142-6/+28
| | | | | | | | | | | Fixes #148. The "force_linenos" config setting of the CodeHilite extension has been marked as Pending Deprecation and a new setting "linenums" has been added to replace it. See documentation for the [CodeHilite Extension] for an explaination of the new "linenums" setting. The new setting will honor the old "force_linenos" if it is set, but it will raise a PendingDeprecationWarning and will likely be removed in a future version of Python-Markdown. [CodeHilite Extension]: extensions/codehilite.html
* Remove RSS Extension.Waylan Limberg2013-02-125-47/+8
| | | | | | Closes #143. If you would like to continue using the extension (not recomended), it is archived on [Github](https://gist.github.com/waylan/4773365).
* Update docs/release-2.3.txtWaylan Limberg2013-02-101-0/+8
|
* Noted in docs that admonitions are experimental.Waylan Limberg2013-02-101-1/+5
|
* Better synthax description in the docs.Tiago Serafim2013-02-091-1/+1
|
* Merge branch 'master' into admonitionTiago Serafim2013-02-0911-57/+241
|\ | | | | | | | | | | Conflicts: docs/extensions/index.txt tests/extensions/test.cfg
| * Footnote ids contain dashes when outputing HTML5.Waylan Limberg2013-02-081-0/+6
| | | | | | | | | | Previously they contained colons - and they still do for HTML4 and XHTML. Fixes #180.
| * 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.
| * Added skeleton draft of Release Notes for 2.3Waylan Limberg2013-02-083-4/+37
| |
| * Improved the goals in docs.Waylan Limberg2013-01-101-3/+5
| |
| * Added a "goals" section to the docs.Waylan Limberg2013-01-101-2/+15
| | | | | | | | | | Now, when we receive feature requests that don't fit within the scope of the Python-Markdown project, we have something to point  to in response.
| * Added a list of known differences to the docs.Waylan Limberg2013-01-101-8/+44
| | | | | | | | | | | | | | | | | | | | | | Rather than constantly responding to new bug reports for known differences between Python-Markdown and other implementations, I've added this section to the docs to definitively state our position and point people to workarounds. I'm sure some people will still file reports, but at least I have something to point them to. If there are any I missed, I can always add them latter when they come up.
| * docs/change_log.txt: add a missing `[`Dmitry Shachnev2012-11-051-1/+1
| |
| * Merge branch 'master' of https://github.com/waylan/Python-Markdown2.2.1.finalWaylan Limberg2012-11-044-29/+70
| |\
| | * Fixed minor typo in attr_list docs. Waylan Limberg2012-11-041-1/+1
| | | | | | | | | Thanks @mitya57.
| | * docs/basic.css: Improve CSS a bitDmitry Shachnev2012-11-031-8/+15
| | |
| | * docs/extensions/index.txt: make it clear what name to pass for extensionsDmitry Shachnev2012-11-031-19/+53
| | |