aboutsummaryrefslogtreecommitdiffstats
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* 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>
* Moved enable_attributes keyword to extension: legacy_attrs.Waylan Limberg2018-07-241-4/+0
| | | | | | | If you have existing documents that use the legacy attributes format, then you should enable the legacy_attrs extension for those documents. Everyone is encouraged to use the attr_list extension going forward. Closes #643. Work adapted from 0005d7a of the md3 branch.
* 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-174-10/+10
|
* Simplify output_formats to html and xhtml.Waylan Limberg2018-01-251-11/+2
| | | | | | | | | | | We started with the numbers before HTML5 was a thing and we thought there might be an XHTML2. Today, we know that all we have are HTML style tags and XHTML style tags. Nothing else really matters in the real world. Note that if '(x)html1' '(x)html4' or '(x)html5' are passed in, the number is stripped/ignored. Users shouldn't need to change their code for this.
* 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.
* Fix 'IndentationError' in release-2.6 documentraimon2018-01-151-2/+2
|
* docs: Remove references to header_id.md page.Dmitry Shachnev2018-01-124-8/+2
| | | | | | | 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-1220-121/+182
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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.
* Removed deprecated safe_mode.Waylan Limberg2018-01-111-81/+3
|
* Document the new test tools.Waylan Limberg2018-01-083-139/+175
|
* Up version to 2.6.11 (#620)2.6.11Waylan Limberg2018-01-041-0/+4
|
* 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.
* Fix spellchecking test.Waylan Limberg2017-12-081-1/+1
| | | | | | * Install deps. * Ensure test fails if deps are missing. * Update dictionary for recent docs changes.
* Build and upload wheels for releases.Waylan Limberg2017-12-081-52/+11
| | | | Update install docs.
* Upped version to 2.6.102.6.10Waylan Limberg2017-12-071-1/+3
| | | | | This version was released to force PyPI to point to the new docs location. Closes #601. The old PyPI hosted docs can be deleted after this.
* Switch docs to MKDocs (#602)Waylan Limberg2017-12-0652-3046/+2291
| | | | | | | | | | | | | | | | | | | | | | | | 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
|
* Upped version to 2.6.9Waylan Limberg2017-08-171-0/+4
|
* GitHub/waylan => GitHub/Python-Markdown orgWaylan Limberg2017-08-1712-13/+13
|
* 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
* Fox formatting of extension_configs example.Waylan Limberg2016-11-171-7/+3
| | | Fixes #511. Thanks to @omiday for the report.
* Up version to 2.6.72.6.7-finalWaylan Limberg2016-09-231-0/+2
|
* 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.
* Convert readthedocs link for their .org -> .io migration for hosted projectsAdam Chainz2016-05-292-3/+3
| | | | | | | | As per [their blog post of the 27th April](https://blog.readthedocs.com/securing-subdomains/) ‘Securing subdomains’: > Starting today, Read the Docs will start hosting projects from subdomains on the domain readthedocs.io, instead of on readthedocs.org. This change addresses some security concerns around site cookies while hosting user generated data on the same domain as our dashboard. Test Plan: Manually visited all the links I’ve modified.
* Added version 2.6.6 to change log.Waylan Limberg2016-05-251-0/+2
| | | Fixes #475.
* Fix lazy ordered list example in documentationsblondon2016-03-301-2/+2
| | | | | | | | | | | | | | | The documentation is not accurate when lazy_ol=False parameter is called. The example shows the 'start' attribute to the first <li> tag. However, the attribute is in the <ol> tag: >>> import markdown >>> s = """ ... 4. Apples ... 5. Oranges ... 6. Pears""" >>> markdown.markdown(s, lazy_ol=False) u'<ol start="4">\n<li>Apples</li>\n<li>Oranges</li>\n<li>Pears</li>\n</ol>' The behaviour of the library is the correct one (https://developer.mozilla.org/fr/docs/Web/HTML/Element/ol), so the documentation need to be fixed, not the library.
* Updated change_logWaylan Limberg2015-11-241-0/+2
|
* Upped to version 2.6.4.2.6.4-finalWaylan Limberg2015-11-061-0/+2
|
* Upped to version 2.6.3.2.6.3-finalWaylan Limberg2015-10-261-0/+2
|
* Updated change_log for 2.6.2.Waylan Limberg2015-04-201-0/+2
|
* fix broken documentation codeJakob Kramer2015-03-131-5/+5
|
* Upped version to 2.6.12.6.1-finalWaylan Limberg2015-03-081-0/+4
|
* 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
|