aboutsummaryrefslogtreecommitdiffstats
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* Code exampeles in extension docs now show best practices.Waylan Limberg2014-08-292-13/+14
| | | | | This is in anticipation of #335. The reference and extension api docs still need to be updated, but that will happen with change in the code.
* Docs now use dot notation for all extensions.Waylan Limberg2014-08-2918-59/+52
| | | | | | Except were "short names" are explained in the docs, all references to the buitlin extensions now use `markdown.extensions.*` in anticipation of #336.
* Various tweaks to release notes.Waylan Limberg2014-08-271-34/+46
|
* Allow named extensions to specify the Class NameWaylan Limberg2014-08-271-0/+30
| | | | | | | | | | | | | | | | | | If you were to import the class like this: from path.to.module import SomeExtensionClass Then the named extension would be the string: "path.to.module:SomeExtensionClass" This should simplify loading extensions from the command line or template filters -- expecially when multiple extensions are defined in a single python module. The docs still need updating. I'm waiting to update the docs after implementing #335 and #336 as that will require a major refactor of that section of the docs anyway.
* Refactored extension importing.Waylan Limberg2014-08-271-1/+4
| | | | | | | | | | | | | We now use importlib which means we no longer support Python 2.6. Also, this refactor properly imports third party extensions which reside at the root of PYTHONPATH. Previously, either `markdown.extensions.` or `mdx_` would be appended to any extension name that did not contain a dot, which required third party extensions to either be in submodules or use the old `mdx_` naming convention. This commit is also in preperation for #336. It will now be much easier to deprecate (and later remove) support for the old ways of handling extension names.
* Note deprecation of `force_linenums` keyword in release notes.Waylan Limberg2014-08-221-3/+9
|
* Added `--extension_configs` option to the CLI.Waylan Limberg2014-08-222-16/+73
| | | | | | | | | | The `--extension_configs` option must point to a YAML or JSON file. The contents of the file must parse to a Python Dict which will be passed to the `extension_configs` keyword of the `markdown.Markdown` class. Also added tests for all of the CLI option parsing options and updated documentation.
* Update docs for tests refactor. INI => YAML. Relates to #333.Waylan Limberg2014-08-212-16/+17
|
* Upped version to 2.5-dev and started release notes.Waylan Limberg2014-08-204-3/+50
|
* Update lib reference docs to reflect that extension_configs accepts dicts. ↵Waylan Limberg2014-08-201-10/+14
| | | | Related to #325
* Renamed 'smart_substitutions' option to 'substitutions'. Fixed a typo.Martin Altmayer2014-08-151-3/+3
|
* Replaced smart_lsquo etc. by a single option smart_substitutions which ↵Martin Altmayer2014-08-111-9/+17
| | | | allows to overwrite all substitution strings. Fixed line length in docs.
* Added options to the Smarty extension that configure the text that is used ↵Martin Altmayer2014-08-091-0/+13
| | | | to replace quotes. This makes it possible to use the correct quotes in languages other than English.
* Updated extension API docs for Extension.__init__ refactorWaylan Limberg2014-08-011-9/+18
| | | Relates 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.
* smarty: add support for angled quotesDmitry Shachnev2014-06-191-11/+13
| | | | See <http://en.wikipedia.org/wiki/Guillemet>.
* 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
|
* Upped version to 2.4 final.2.4-finalWaylan Limberg2014-02-161-1/+1
|
* Cleaned up some minor issues with recent changes to docs.Waylan Limberg2014-02-168-36/+55
|
* docs: capitalization fixes, plural fixes, small wording improvementsJakub Klinkovský2014-02-1517-54/+56
|
* docs: update wikilinks documentationJakub Klinkovský2014-02-151-38/+24
|
* docs: update toc documentationJakub Klinkovský2014-02-151-30/+43
|
* docs: update smarty documentationJakub Klinkovský2014-02-151-19/+10
|
* docs: update sane_lists documentationJakub Klinkovský2014-02-151-12/+4
|
* docs: update nl2br documentationJakub Klinkovský2014-02-151-3/+15
|
* docs: update meta_data documentationJakub Klinkovský2014-02-151-14/+25
|
* docs: update header_id documentationJakub Klinkovský2014-02-151-10/+16
|
* docs: update codehilite documentationJakub Klinkovský2014-02-151-67/+72
|
* 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.
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-19 06:20:17 +0000