<feed xmlns='http://www.w3.org/2005/Atom'>
<title>delta/python-markdown.git/docs/reference.md, branch 3.0.1</title>
<subtitle>github.com: waylan/Python-Markdown.git
</subtitle>
<link rel='alternate' type='text/html' href='http://git.baserock.org/cgit/delta/python-markdown.git/'/>
<entry>
<title>Update 3.0 release notes</title>
<updated>2018-08-03T23:18:34+00:00</updated>
<author>
<name>Waylan Limberg</name>
<email>waylan.limberg@icloud.com</email>
</author>
<published>2018-08-02T18:51:16+00:00</published>
<link rel='alternate' type='text/html' href='http://git.baserock.org/cgit/delta/python-markdown.git/commit/?id=833574a9da27874614f7184f85f7993a539f3df1'/>
<id>833574a9da27874614f7184f85f7993a539f3df1</id>
<content type='text'>
And other docs cleanup.
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
And other docs cleanup.
</pre>
</div>
</content>
</entry>
<entry>
<title>Moved enable_attributes keyword to extension: legacy_attrs.</title>
<updated>2018-07-24T15:40:13+00:00</updated>
<author>
<name>Waylan Limberg</name>
<email>waylan.limberg@icloud.com</email>
</author>
<published>2015-03-30T03:00:30+00:00</published>
<link rel='alternate' type='text/html' href='http://git.baserock.org/cgit/delta/python-markdown.git/commit/?id=ee54678185234f01d3de6a6334f30c9bb3417783'/>
<id>ee54678185234f01d3de6a6334f30c9bb3417783</id>
<content type='text'>
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.
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
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.
</pre>
</div>
</content>
</entry>
<entry>
<title>Fix typos</title>
<updated>2018-02-17T20:15:56+00:00</updated>
<author>
<name>Jakub Wilk</name>
<email>jwilk@jwilk.net</email>
</author>
<published>2018-02-17T09:58:49+00:00</published>
<link rel='alternate' type='text/html' href='http://git.baserock.org/cgit/delta/python-markdown.git/commit/?id=b0e993a23ab96562d9e0e86fcba715c9d8b9ffcf'/>
<id>b0e993a23ab96562d9e0e86fcba715c9d8b9ffcf</id>
<content type='text'>
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
</pre>
</div>
</content>
</entry>
<entry>
<title>Simplify output_formats to html and xhtml.</title>
<updated>2018-01-25T19:04:09+00:00</updated>
<author>
<name>Waylan Limberg</name>
<email>waylan.limberg@icloud.com</email>
</author>
<published>2015-03-29T01:48:41+00:00</published>
<link rel='alternate' type='text/html' href='http://git.baserock.org/cgit/delta/python-markdown.git/commit/?id=8c0698b013edeb82586290e637df7c30ede81b5a'/>
<id>8c0698b013edeb82586290e637df7c30ede81b5a</id>
<content type='text'>
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.
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
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.
</pre>
</div>
</content>
</entry>
<entry>
<title>Refactor Extension loading (#627)</title>
<updated>2018-01-13T03:48:41+00:00</updated>
<author>
<name>Waylan Limberg</name>
<email>waylan.limberg@icloud.com</email>
</author>
<published>2018-01-13T03:48:41+00:00</published>
<link rel='alternate' type='text/html' href='http://git.baserock.org/cgit/delta/python-markdown.git/commit/?id=cd7324333a995eeb62a3e6eacdb3b179c6256133'/>
<id>cd7324333a995eeb62a3e6eacdb3b179c6256133</id>
<content type='text'>
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'])

</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
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'])

</pre>
</div>
</content>
</entry>
<entry>
<title>Removed deprecated safe_mode.</title>
<updated>2018-01-12T00:04:49+00:00</updated>
<author>
<name>Waylan Limberg</name>
<email>waylan.limberg@icloud.com</email>
</author>
<published>2015-03-15T00:39:46+00:00</published>
<link rel='alternate' type='text/html' href='http://git.baserock.org/cgit/delta/python-markdown.git/commit/?id=7f63b20b819b83afef0ddadc2e210ddce32a2be3'/>
<id>7f63b20b819b83afef0ddadc2e210ddce32a2be3</id>
<content type='text'>
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
</pre>
</div>
</content>
</entry>
<entry>
<title>Switch docs to MKDocs (#602)</title>
<updated>2017-12-07T04:18:29+00:00</updated>
<author>
<name>Waylan Limberg</name>
<email>waylan.limberg@icloud.com</email>
</author>
<published>2017-12-07T04:18:29+00:00</published>
<link rel='alternate' type='text/html' href='http://git.baserock.org/cgit/delta/python-markdown.git/commit/?id=b62ddeda02fadcd09def9354eb2ef46a7562a106'/>
<id>b62ddeda02fadcd09def9354eb2ef46a7562a106</id>
<content type='text'>
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 =&gt; filename.md

* pythonhost.org/Markdown =&gt; 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.
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
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 =&gt; filename.md

* pythonhost.org/Markdown =&gt; 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.
</pre>
</div>
</content>
</entry>
<entry>
<title>Rename docs/*.md =&gt; docs/*.txt</title>
<updated>2012-03-07T14:35:40+00:00</updated>
<author>
<name>Waylan Limberg</name>
<email>waylan@gmail.com</email>
</author>
<published>2012-03-07T14:35:40+00:00</published>
<link rel='alternate' type='text/html' href='http://git.baserock.org/cgit/delta/python-markdown.git/commit/?id=ec46692cf5c4d5e22950bc8e7d14cb0ec327fb87'/>
<id>ec46692cf5c4d5e22950bc8e7d14cb0ec327fb87</id>
<content type='text'>
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.
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
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.
</pre>
</div>
</content>
</entry>
<entry>
<title>Fixed up some formating errors in docs and added/fixed more internal links.</title>
<updated>2012-03-07T14:08:36+00:00</updated>
<author>
<name>Waylan Limberg</name>
<email>waylan@gmail.com</email>
</author>
<published>2012-03-07T14:08:36+00:00</published>
<link rel='alternate' type='text/html' href='http://git.baserock.org/cgit/delta/python-markdown.git/commit/?id=9fd4a5f1600c96406ad0fb86b1a8287d525972ac'/>
<id>9fd4a5f1600c96406ad0fb86b1a8287d525972ac</id>
<content type='text'>
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
</pre>
</div>
</content>
</entry>
<entry>
<title>Added a bunch of internal links to the docs.</title>
<updated>2012-03-07T13:43:36+00:00</updated>
<author>
<name>Waylan Limberg</name>
<email>waylan@gmail.com</email>
</author>
<published>2012-03-07T13:43:36+00:00</published>
<link rel='alternate' type='text/html' href='http://git.baserock.org/cgit/delta/python-markdown.git/commit/?id=9c2830f7b0273ae399b771a7d9780ee7a7430fc4'/>
<id>9c2830f7b0273ae399b771a7d9780ee7a7430fc4</id>
<content type='text'>
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
</pre>
</div>
</content>
</entry>
</feed>
