aboutsummaryrefslogtreecommitdiffstats
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* Removed `yaml` option from meta-data extension.Waylan Limberg2015-03-082-20/+10
| | | | | The option was buggy. Rather than try to fix it, it is being removed. This feeture should exist as a seperate extension. Fixes #390.
* Upped version to 2.6 final2.6-finalWaylan Limberg2015-02-191-1/+1
|
* Cleaned up spelling (again).Waylan Limberg2015-02-181-4/+4
|
* Reformatted Release Notes for 2.6.Waylan Limberg2015-02-181-154/+188
| | | | | | | | | This format (using subheading rather than lists), allows for easy linking to each individual section of the release notes. I think we should sue this format going forward. Also added an additional example to clarify the deprecation of the special treatment of the 'mdx_' prefix for third party extensions.
* Thorough spell check of the docs.Waylan Limberg2015-02-0728-429/+441
|
* Added a 'use_pygments' config option to CodeHilite.Waylan Limberg2015-02-052-1/+22
| | | | | | | | | Fixes #386. I'm doing this against my better judgement. The only reason is that I'm using the HTML format suggested by the HTML5 Spec and will simply not consider any alternate output. If a JavaScript library requires something else, to bad. I don't care. That library should support the format suggested by the spec or I'm not interested in it. If you want something else then you can create your own extension which does whatever you want.
* Upgraded to DeprecationWarning on ext `config` keyword.Waylan Limberg2015-02-051-9/+57
| | | | | | | | | Also checked for `None` so the existing extensions will at least still work. Of course, that code all gets deleted with the next release and things will break if extension authors do not update their code. Hope they test there code with each release and check for warnings. Also added a note to the release notes.
* typo fixnikolas2015-01-281-1/+1
|
* Fix typo in release-2.6.txtnikolas2015-01-281-1/+1
|
* Add offical support for PyPy.Waylan Limberg2015-01-101-1/+6
|
* Clean up a few typos and formatting issues.Waylan Limberg2015-01-012-55/+51
|
* Merge branch 'master' of https://github.com/waylan/Python-MarkdownWaylan Limberg2015-01-011-1/+1
|\
| * Fix a small typoAlexander Artemenko2014-12-311-1/+1
| |
* | HeaderId Extension marked as Pending Deprecation.Waylan Limberg2015-01-013-34/+110
|/ | | | | | | | | | | | | | | | | | | | Use the Table of Contents Extension instead. The HeaderId Extension will raise a PendingDeprecationWarning. The last few features of the HeaderID extension were mirgrated to TOC including the baselevel and separator config options. Also, the marker config option of TOC can be set to an empty string to disable searching for a marker. The `slugify`, `unique` and `stashedHTML2text` functions are now defined in the TOC extension in preperation for the HeaderId extension being removed. All coresponding tests are now run against the TOC Extension. The meta-data support of the HeaderId Extension was not migrated and no plan exists to make that migration. The `forceid` config option makes no sense in the TOC Extension and the only other config setting supported by meta-data was the `header_level`. However, as that depends on the template, it makes more sense to not be defined at the document level.
* Added first draft of 2.6 release notes.Waylan Limberg2014-12-305-6/+142
|
* Better docs of treeprocessor API.Waylan Limberg2014-12-291-3/+14
| | | Fixes #375. Explains the difference between returning None and returning a modified root element. Also makes the docs more consistent with the doc strings in the code.
* Merge pull request #378 from d0ugal/docs-fixWaylan Limberg2014-12-231-4/+5
|\ | | | | Correct the documentation for the slugify function
| * Correct the documentation for the slugify functionDougal Matthews2014-12-221-4/+5
| | | | | | | | | | The previous requirements are incorrect, the method needs to accept two parameters.
* | Add YAML support to Meta extensionKernc2014-11-301-6/+26
|/ | | | | | | | By default, this only supports YAML deliminators (`---`) and adds no additional behavior. In other words, parsing is unchanged. However, with the `yaml` option set, PyYAML will parse the metadata. Thanks to @kernc for suggesting the idea and doing the work on this.
* Added 2.5.2 to changelog.Waylan Limberg2014-11-201-0/+2
|
* Updated nl2br example in docs.Waylan Limberg2014-10-281-1/+1
| | | Fixes #359. Thanks for the report @gremmie.
* Upped version to 2.5.12.5.1-finalWaylan Limberg2014-09-262-6/+5
| | | | Also removed an inacurate statement in the 2.5 release notes.
* Add 2.5 release date, and fix a typo.Dmitry Shachnev2014-09-152-2/+2
|
* Mark "Safe Mode" as pending deprecation.Waylan Limberg2014-09-013-25/+72
| | | | | Both `safe_mode` and `html_replacement_test` keywords are pending deprecation, as are positional args. Closes #337.
* Some docs cleanup.Waylan Limberg2014-08-297-60/+53
|
* Updated extension API docs for recent changes.Waylan Limberg2014-08-292-46/+70
|
* Mark special treatment of extension names as PendingDeprecationWaylan Limberg2014-08-293-27/+55
| | | | | | | | | | | | | | | | | 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.
* 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
|
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-30 21:18:05 +0000