summaryrefslogtreecommitdiff
path: root/docs/extensions
Commit message (Collapse)AuthorAgeFilesLines
* Update documentation in file `toc.md` in `slugify` part.Vyacheslav.Redlov2022-11-281-2/+2
|
* docs: Fix a few typosTim Gates2022-07-252-3/+3
| | | | | | | | | | | | | | | | | There are small typos in: - docs/extensions/fenced_code_blocks.md - docs/extensions/meta_data.md - markdown/extensions/codehilite.py - markdown/extensions/footnotes.py - tests/test_legacy.py Fixes: - Should read `delimiters` rather than `deliminators`. - Should read `shebang` rather than `sheband`. - Should read `processing` rather than `proccesing`. - Should read `backslash` rather than `blackslash`. Signed-off-by: Tim Gates <tim.gates@iress.com>
* Bump version to 3.43.4Waylan Limberg2022-07-151-2/+2
| | | Cleaned up the release notes.
* Pass language to Pygments formatter in CodeHiliteLiang-Bo Wang2022-05-181-3/+49
| | | | | | | | * Add an extra option `lang_str` to pass the language of the code block to the specified Pygments formatter. * Include an example custom Pygments formatter in the documentation that includes the language of the code in the output using the new option. Resolves #1255.
* Support for custom Pygments formatterShrikant Sharat Kandula2022-05-091-0/+10
| | | | | This adds configuration support for using a custom Pygments formatter, either by giving the string name, or a custom formatter class (or callable).
* Support custom CSS class on TOC elementJannis Vajen2022-05-051-0/+3
| | | Closes #1224
* Footnotes improvementsysard2022-05-051-2/+6
| | | | | | | | | | | | | * footnotes: Allow to use backlink title without footnote number - The placeholder '{}' is optional. So a user can choose to include or not the footnote number in the backlink text. - The modification is backward compatible with configurations using the old '%d' placeholder. * footnotes: Allow to use custom superscript text - The addition of a new SUPERSCRIPT_TEXT option allows to specify a placeholder receiving the footnote number for the superscript text.
* fixed link #1154ireznikov2022-05-051-1/+1
|
* Update th/td to use style attributeGaige B Paulsen2022-05-051-1/+21
| | | | | | | | | | This allows better interoperation with CSS style sheets, as the align object on the TH is skipped if the css uses 'text-align: inherit' and the previous 'text-align' is used instead (or the default: left). Added an override to restore the original `align` behavior Moved existing tests to the new test infrastructure Added new tests to test the configuration parameter Updated documentation to document the configuration parameter.
* Fix typos and remove trailing spacesKian-Meng Ang2022-04-101-25/+25
|
* document footnote's need for reset() between multiple runsPeter Kaminski2021-07-061-0/+28
| | | | | | The footnote docs page doesn't mention the need to run `reset()` between multiple runs of the `markdown.Markdown` class. This change adapts and adds language from the `extensions/api.md` page to explain what to do and why.
* Fix link to extensions tutorialJannis Vajen2021-05-261-1/+1
| | | The previous link was pointing at a stale wiki page.
* Add an HtmlStash section to docsCris Luengo2021-01-281-0/+19
|
* Replace effbot.org linksWaylan Limberg2020-12-081-4/+3
| | | | | | | effbot.org was the old site for ElementTree from before it was added to the Python standard library. We now link to the standard library which is up-to-date and avoid bad links to a third-party site which is currently down.
* Unify all block-level tags. (#1048)Waylan Limberg2020-10-201-4/+4
| | | | | | Use the list of tags defined in the core by the md_in_html extension. This ensures that the lists do not diverge and allows users and/or extensions to expand the list in the core and have that change affect the extension. Fixes #1047.
* Ensure consistent handling of classes by fenced_code and codehilite (#1033)Waylan Limberg2020-10-081-2/+2
| | | | | | | * All non-language classes should always be assigned to the pre tag. * The language identifying class should never be included with the general list of classes. Fixes #1032
* Support unicode ids in toc (#970)Antoine2020-10-011-0/+3
| | | A second function, `slugify_unicode` was added rather than changing the existing function so as to maintain backward compatibility. While an `encoding` parameter was added to the `slugify` function, we can't expect existing third party functions to accept a third parameter. Therefore, the two parameter API was preserved with this change.
* Refactor HTML Parser (#803)Waylan Limberg2020-09-221-75/+187
| | | | | | | | | | The HTML parser has been completely replaced. The new HTML parser is built on Python's html.parser.HTMLParser, which alleviates various bugs and simplifies maintenance of the code. The md_in_html extension has been rebuilt on the new HTML Parser, which drastically simplifies it. Note that raw HTML elements with a markdown attribute defined are now converted to ElementTree Elements and are rendered by the serializer. Various bugs have been fixed. Link reference parsing, abbreviation reference parsing and footnote reference parsing has all been moved from preprocessors to blockprocessors, which allows them to be nested within other block level elements. Specifically, this change was necessary to maintain the current behavior in the rebuilt md_in_html extension. A few random edge-case bugs (see the included tests) were resolved in the process. Closes #595, closes #780, closes #830 and closes #1012.
* Document passing configuration options to Extra.Waylan Limberg2020-09-171-7/+31
| | | | Closes #1019.
* Update information about richleland/pygments-css.Waylan Limberg2020-09-101-6/+7
| | | | As of richleland/pygments-css@146834e1 the css class was set to `.highlight`. Closes #1020.
* Add suport for attr_lists in table headers.Waylan Limberg2020-06-301-0/+2
|
* Tune attr list regexWaylan Limberg2020-06-302-1/+41
| | | | | | | | | | | Ignore empty braces. Braces must contain at least one non-whitepsace character to be recognized as an attr list. Attr lists for table cells must be at the end of the cell content and must be seperated from the content by at least one space. This appears to be a breaking change. However, it is consistent with the behavior elsewhere. Fixes #898.
* Clarify attr_list docsWaylan Limberg2020-06-251-2/+32
| | | | | Document the behavior of single terms and clarify other behaviors. Addresses #964.
* Refactor fenced_code & codehilite options (#816)Waylan Limberg2020-06-232-77/+233
| | | | | | | | | | | | | | | | | | | | * Add `language-` prefix to output when syntax highlighting is disabled for both codehilite and fenced_code extensions. * Add `lang_prefix` config option to customize the prefix. * Add a 'pygments' env to tox which runs the tests with Pygments installed. Pygments is locked to a specific version in the env. * Updated codehilite to accept any Pygments options. * Refactor fenced code attributes. - ID attr is defined on `pre` tag. - Add support for attr_list extension, which allows setting arbitrary attributes. - When syntax highlighting is enabled, any pygments options can be defined per block in the attr list. - For backward compatibility, continue to support `hi_lines` outside of an attr_list. That is the only attr other than lang which is allowed without the brackets (`{}`) of an attr list. Note that if the brackets exist, then everything, including lang and hl_lines, must be within them. * Resolves #775. Resolves #334. Addresses #652.
* Document limitations if attr_list extension.Waylan Limberg2020-05-141-0/+29
| | | | Closes #965.
* Documentation cleanup.Waylan Limberg2020-05-081-0/+4
|
* Add checklinks tox env and shell script. (#955)Waylan Limberg2020-05-072-3/+3
| | | Also clean up dead links.
* Refactor Extension API docs (#946)Charles Merriam2020-05-071-493/+546
| | | | | * Move Patterns sections. Fixes #729. * Rewrite tree processor docs. Fixes #949.
* Simplify xml.etree.ElementTree loading (#902)Dmitry Shachnev2020-02-031-16/+6
| | | | | | | | cElementTree is a deprecated alias for ElementTree since Python 3.3. Also drop the recommendation to import etree from markdown.util, and deprecate markdown.util.etree.
* Add permalink_title option (#886)Waylan Limberg2019-11-261-0/+3
| | | | | Addes a new `permalink_title` option to the TOC extension, which allows the title attribute of a permalink to be set to something other than the default English string "Permanent link". Fixes #781.
* Add anchorlink_class and permalink_class options to TOCWaylan Limberg2019-11-261-0/+6
| | | | | | | | | Two new configuration options have been added to the toc extension: `anchorlink_class` and `permalink_class` which allows class(es) to be assigned to the `anchorlink` and `permalink` HTML respectively. This allows using icon fonts from CSS for the links. Therefore, an empty string passed to `permalink` now generates an empty `permalink`. Previously no `permalink` would have been generated. Based on #776.
* legacy_attr => legacy_attrs. (#870)NNRepos2019-10-292-4/+4
| | | Fixes #868.
* Always wrap CodeHilite code in <code> tags (#862)Tim Martin2019-09-301-5/+12
| | | Pygments added the `wrapcode` option in version 2.4. Users need to have 2.4+ installed to see the change. However, as earlier versions accepted arbitrary keywords passed to the HTMLFormatter, no error will be raised if the user has an older version of Pygments installed.
* Close code tagOskar Sharipov2019-09-161-0/+1
|
* Separate Markdown parsing in HTML to separate extension (#859)Isaac Muse2019-09-043-129/+147
| | | | | Move Markdown parsing from the extra extension to a separate extension called md_in_html.
* fix: Typo (#857)Patrick Browne2019-08-311-1/+1
|
* Added trivial examples to extension docsJamie Scott2019-08-0116-2/+98
| | | | Fixes #854.
* Update extra.mdMatt Sephton2019-06-251-1/+1
|
* Use https:// links where availableJon Dufresne2019-06-127-12/+12
|
* Fix TOC docsWaylan Limberg2019-03-251-7/+7
|
* Add support for a range to toc_depth.Klaus Mueller2019-02-221-6/+12
| | | | Closes #786.
* Clarify in docs that a high value corresponds to high extension priority (#756)Maurice van der Pot2018-11-181-2/+3
| | | This fixes #755
* foot note adjustments (#728)Isaac Muse2018-10-091-0/+3
| | | | | | Add a config to set the footnote separator. Also remove rel/rev as they aren't really compatible with HTML5 and we already have classes set for refs and backrefs. Fixes 723.
* Support custom labels in TOC. (#700)Waylan Limberg2018-09-051-1/+62
| | | | | | | | New `toc_tokens` attribute on Markdown class. Contains the raw tokens used to build the Table of Contents. Users can use this to build their own custom Table of Contents rather than needing to parse the HTML available on the `toc` attribute of the Markdown class.
* Update 3.0 release notesWaylan Limberg2018-08-0310-144/+183
| | | | And other docs cleanup.
* 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
|
View Lorry Controller Status