aboutsummaryrefslogtreecommitdiffstats
path: root/docs/extensions
Commit message (Collapse)AuthorAgeFilesLines
* Add toc_depth parameter to toc extensionJesús Fernández2018-07-241-0/+8
|
* Add the possibility to set additional classesWhiteWinterWolf2018-07-241-2/+20
| | | | | | | | | | | | | | | | | Additional CSS classes names can be appended to the admonition name using spaces as separators. The following markdown: !!! note floatright This is a floating note. Generates the following HTML code: <div class="admonition note floatright"> <p class="admonition-title">Note</p> <p>This is a floating note.</p> </div>
* typo fix in nl2br.md (#673)Vyacheslav Matyukhin2018-06-231-1/+1
|
* Fix formatting in fenced code block exampleDmitry Shachnev2018-06-051-2/+2
|
* Fix typosJakub Wilk2018-02-172-8/+8
|
* Flexible inline (#629)Isaac Muse2018-01-171-1/+108
| | | | Add new InlineProcessor class that handles inline processing much better and allows for more flexibility. This adds new InlineProcessors that no longer utilize unnecessary pretext and posttext captures. New class can accept the buffer that is being worked on and manually process the text without regex and return new replacement bounds. This helps us to handle links in a better way and handle nested brackets and logic that is too much for regular expression. The refactor also allows image links to have links/paths with spaces like links. Ref #551, #613, #590, #161.
* docs: Remove references to header_id.md page.Dmitry Shachnev2018-01-122-4/+0
| | | | | | | The page was removed along with the extension in 1127013. Also ensure any future MkDocs warnings cause the build to fail in the tests so we don't introduce similar errors in the future.
* Refactor Extension loading (#627)Waylan Limberg2018-01-1218-87/+125
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Deprecated naming support is removed: * Removed special treatment for modules in `markdown.extensions` * Removed support for `mdx_` prefixes. Support for Entry Point names added: Support for "short names" are now implemented with entry points. Therefore all the users who call extension names as `toc` will not get errors as the builtin extensions all have entry points defined which match the old "short names" for modules in `markdown.extensions`. The benefit is that any extension can offer the same support without requiring the user to manually copy a file to that location on the file system (way to many extension authors have included such instructions in their installation documentation). The one odd thing about this is that we have been issuing a DeprecationWarning for short names and now they are fully supported again. But I think it's the right thing to do. Support for using dot notation is not removed. After all, it was never deprecated. And we shouldn't "force" entry points. There are plenty of reasons why users may not want that and not all of them can be resolved by using class instances instead. All of the following ways to load an extension are valid: # Class instance from markdown.extensions.toc import TocExtension markdown.markdown(src, extensions=[TocExtension()] # Entry point name markdown.markdown(src, extensions=['toc']) # Dot notation with class markdown.markdown(src, extensions=['markdown.extensions.toc:TocExtension']) # Dot notation without class markdown.markdown(src, extensions=['markdown.extensions.toc'])
* Removed deprecated HeaderId Extension.Waylan Limberg2018-01-111-131/+0
| | | | Use the TOC extension instead.
* Remove unwanted apostrophe from docsAlex Chan2017-12-271-1/+1
|
* [Footnote extension] Add a way to customize the backlink title (#616)Jorge Maldonado Ventura2017-12-221-0/+6
| | | Fixes #610.
* Switch docs to MKDocs (#602)Waylan Limberg2017-12-0624-971/+1060
| | | | | | | | | | | | | | | | | | | | | | | | 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.
* Feature ancestry (#598)Isaac Muse2017-11-231-1/+5
| | | | | Ancestry exclusion for inline patterns. Adds the ability for an inline pattern to define a list of ancestor tag names that should be avoided. If a pattern would create a descendant of one of the listed tag names, the pattern will not match. Fixes #596.
* Clean up some docs formatting.Waylan Limberg2017-09-181-8/+8
|
* GitHub/waylan => GitHub/Python-Markdown orgWaylan Limberg2017-08-171-1/+1
|
* The location keyword of OrderedDict.add is not optional.Waylan Limberg2017-03-091-1/+1
| | | Fixes #554.
* command line (#517)Ben Petty2016-12-231-1/+1
| | | add . before `codehilite` to generate a proper css output (to reference the codehilite class)
* Spelling error (#516)Ben Petty2016-12-231-1/+1
| | | should say `pygmentize` not `pygmetize` on line 50
* Fix a few spelling errors.Waylan Limberg2016-09-231-3/+3
|
* Additional improvements to Codehilite docs. Addesses concerns raised in #480.Waylan Limberg2016-06-061-18/+45
|
* 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
|
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-24 19:04:24 +0000