aboutsummaryrefslogtreecommitdiffstats
path: root/docs/extensions
Commit message (Collapse)AuthorAgeFilesLines
* added instructions for CodeHilite with PygmentsKristian Rother2016-06-061-8/+15
| | | Improved the setup documentation when rendering Python code with Pygments and CodeHilite. Added a link to the Pygments CSS files and emphasized that not installing pygments does not cause an error message.
* fix broken documentation codeJakob Kramer2015-03-131-5/+5
|
* Removed `yaml` option from meta-data extension.Waylan Limberg2015-03-081-19/+5
| | | | | The option was buggy. Rather than try to fix it, it is being removed. This feeture should exist as a seperate extension. Fixes #390.
* Thorough spell check of the docs.Waylan Limberg2015-02-0713-234/+246
|
* Added a 'use_pygments' config option to CodeHilite.Waylan Limberg2015-02-051-1/+10
| | | | | | | | | 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.
* Clean up a few typos and formatting issues.Waylan Limberg2015-01-011-8/+4
|
* HeaderId Extension marked as Pending Deprecation.Waylan Limberg2015-01-012-26/+75
| | | | | | | | | | | | | | | | | | | | 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-301-2/+2
|
* 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.
* Updated nl2br example in docs.Waylan Limberg2014-10-281-1/+1
| | | Fixes #359. Thanks for the report @gremmie.
* Some docs cleanup.Waylan Limberg2014-08-293-34/+29
|
* Updated extension API docs for recent changes.Waylan Limberg2014-08-291-46/+68
|
* 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-2917-45/+45
| | | | | | Except were "short names" are explained in the docs, all references to the buitlin extensions now use `markdown.extensions.*` in anticipation of #336.
* 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.
* smarty: add support for angled quotesDmitry Shachnev2014-06-191-11/+13
| | | | See <http://en.wikipedia.org/wiki/Guillemet>.
* 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-131-4/+4
|
* 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
|/
* 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.
* Add documentation for smarty extensionDmitry Shachnev2013-07-264-4/+62
|
* 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.
* Removed html_tidy docs.Waylan Limberg2013-03-131-34/+0
|
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-06 11:21:32 +0000