aboutsummaryrefslogtreecommitdiffstats
path: root/docs/extensions/index.md
Commit message (Collapse)AuthorAgeFilesLines
* docs: Remove references to header_id.md page.Dmitry Shachnev2018-01-121-1/+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-121-25/+23
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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'])
* Switch docs to MKDocs (#602)Waylan Limberg2017-12-061-0/+86
| | | | | | | | | | | | | | | | | | | | | | | | 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.
* Rename docs/*.md => docs/*.txtWaylan Limberg2012-03-071-63/+0
| | | | | | | | | The documentation uses features of Python-Markdown that are not supported on GitHub and it's better to get a source view of the docs anyway. For example, that way comments and bug reports can reference a specific line of a file. Of course, it makes sense for Github to render the README, so that is left with the `.md` file extension.
* Fixed up some formating errors in docs and added/fixed more internal links.Waylan Limberg2012-03-071-1/+1
|
* Renamed a few docswith better file names.Waylan Limberg2012-03-071-8/+6
|
* Refactored Docs to use Sphinx styled template.Waylan Limberg2012-03-011-1/+8
| | | | | | This is not a full Sphinx implementation. Just a limited implementation which converts our markdown source filed to work with the default css for Sphinx so it looks like Pythons docs.
* Fixes #64. Added sane_list extension.Waylan Limberg2012-01-241-0/+1
| | | | | | | | | | This is an extension which alters the behavior of lists to be less surprising. If turned out to be rather simple to code. I'm surprised no one had written it yet. I should note that this extension does not generate separate lists if different unordered list markers are used (`*` verses `-` verses `+`) The way the parser works that would be a little more tricky.
* Updated docs/extensions/index to be more informative - not just list extensions.Waylan Limberg2011-10-061-2/+30
|
* Updated docs to no longer use the [[wikilink]] style links from the old ↵Waylan Limberg2011-09-221-17/+16
| | | | wiki. All links are not realative links which should work with the supplied docs generator.
* Renamed *.txt -> *.md in docs.Waylan Limberg2011-08-231-0/+30