797 lines
27 KiB
Text
797 lines
27 KiB
Text
|
PHP Markdown
|
|||
|
============
|
|||
|
|
|||
|
Version 1.0.2 - 29 Nov 2013
|
|||
|
|
|||
|
by Michel Fortin
|
|||
|
<http://michelf.ca/>
|
|||
|
|
|||
|
based on work by John Gruber
|
|||
|
<http://daringfireball.net/>
|
|||
|
|
|||
|
|
|||
|
Introduction
|
|||
|
------------
|
|||
|
|
|||
|
Markdown is a text-to-HTML conversion tool for web writers. Markdown
|
|||
|
allows you to write using an easy-to-read, easy-to-write plain text
|
|||
|
format, then convert it to structurally valid XHTML (or HTML).
|
|||
|
|
|||
|
"Markdown" is two things: a plain text markup syntax, and a software
|
|||
|
tool, written in Perl, that converts the plain text markup to HTML.
|
|||
|
PHP Markdown is a port to PHP of the original Markdown program by
|
|||
|
John Gruber.
|
|||
|
|
|||
|
PHP Markdown can work as a plug-in for WordPress, as a modifier for
|
|||
|
the Smarty templating engine, or as a replacement for Textile
|
|||
|
formatting in any software that supports Textile.
|
|||
|
|
|||
|
Full documentation of Markdown's syntax is available on John's
|
|||
|
Markdown page: <http://daringfireball.net/projects/markdown/>
|
|||
|
|
|||
|
|
|||
|
Installation and Requirement
|
|||
|
----------------------------
|
|||
|
|
|||
|
PHP Markdown requires PHP version 4.0.5 or later.
|
|||
|
|
|||
|
Before PHP 5.3.7, pcre.backtrack_limit defaults to 100 000, which is too small
|
|||
|
in many situations. You might need to set it to higher values. Later PHP
|
|||
|
releases defaults to 1 000 000, which is usually fine.
|
|||
|
|
|||
|
|
|||
|
### WordPress ###
|
|||
|
|
|||
|
PHP Markdown works with [WordPress][wp], version 1.2 or later.
|
|||
|
|
|||
|
[wp]: http://wordpress.org/
|
|||
|
|
|||
|
1. To use PHP Markdown with WordPress, place the "markdown.php" file
|
|||
|
in the "plugins" folder. This folder is located inside
|
|||
|
"wp-content" at the root of your site:
|
|||
|
|
|||
|
(site home)/wp-content/plugins/
|
|||
|
|
|||
|
2. Activate the plugin with the administrative interface of
|
|||
|
WordPress. In the "Plugins" section you will now find Markdown.
|
|||
|
To activate the plugin, click on the "Activate" button on the
|
|||
|
same line as Markdown. Your entries will now be formatted by
|
|||
|
PHP Markdown.
|
|||
|
|
|||
|
3. To post Markdown content, you'll first have to disable the
|
|||
|
"visual" editor in the User section of WordPress.
|
|||
|
|
|||
|
You can configure PHP Markdown to not apply to the comments on your
|
|||
|
WordPress weblog. See the "Configuration" section below.
|
|||
|
|
|||
|
It is not possible at this time to apply a different set of
|
|||
|
filters to different entries. All your entries will be formatted by
|
|||
|
PHP Markdown. This is a limitation of WordPress. If your old entries
|
|||
|
are written in HTML (as opposed to another formatting syntax, like
|
|||
|
Textile), they'll probably stay fine after installing Markdown.
|
|||
|
|
|||
|
|
|||
|
### Replacing Textile in TextPattern ###
|
|||
|
|
|||
|
[TextPattern][tp] use [Textile][tx] to format your text. You can
|
|||
|
replace Textile by Markdown in TextPattern without having to change
|
|||
|
any code by using the *Textile Compatibility Mode*. This may work
|
|||
|
with other software that expect Textile too.
|
|||
|
|
|||
|
[tx]: http://www.textism.com/tools/textile/
|
|||
|
[tp]: http://www.textpattern.com/
|
|||
|
|
|||
|
1. Rename the "markdown.php" file to "classTextile.php". This will
|
|||
|
make PHP Markdown behave as if it was the actual Textile parser.
|
|||
|
|
|||
|
2. Replace the "classTextile.php" file TextPattern installed in your
|
|||
|
web directory. It can be found in the "lib" directory:
|
|||
|
|
|||
|
(site home)/textpattern/lib/
|
|||
|
|
|||
|
Contrary to Textile, Markdown does not convert quotes to curly ones
|
|||
|
and does not convert multiple hyphens (`--` and `---`) into en- and
|
|||
|
em-dashes. If you use PHP Markdown in Textile Compatibility Mode, you
|
|||
|
can solve this problem by installing the "smartypants.php" file from
|
|||
|
[PHP SmartyPants][psp] beside the "classTextile.php" file. The Textile
|
|||
|
Compatibility Mode function will use SmartyPants automatically without
|
|||
|
further modification.
|
|||
|
|
|||
|
[psp]: http://michelf.ca/projects/php-smartypants/
|
|||
|
|
|||
|
|
|||
|
### Updating Markdown in Other Programs ###
|
|||
|
|
|||
|
Many web applications now ship with PHP Markdown, or have plugins to
|
|||
|
perform the conversion to HTML. You can update PHP Markdown in many of
|
|||
|
these programs by swapping the old "markdown.php" file for the new one.
|
|||
|
|
|||
|
Here is a short non-exhaustive list of some programs and where they
|
|||
|
hide the "markdown.php" file.
|
|||
|
|
|||
|
| Program | Path to Markdown
|
|||
|
| ------- | ----------------
|
|||
|
| [Pivot][] | `(site home)/pivot/includes/markdown/markdown.php`
|
|||
|
|
|||
|
If you're unsure if you can do this with your application, ask the
|
|||
|
developer, or wait for the developer to update his application or
|
|||
|
plugin with the new version of PHP Markdown.
|
|||
|
|
|||
|
[Pivot]: http://pivotlog.net/
|
|||
|
|
|||
|
|
|||
|
### In Your Own Programs ###
|
|||
|
|
|||
|
You can use PHP Markdown easily in your current PHP program. Simply
|
|||
|
include the file and then call the Markdown function on the text you
|
|||
|
want to convert:
|
|||
|
|
|||
|
include_once "markdown.php";
|
|||
|
$my_html = Markdown($my_text);
|
|||
|
|
|||
|
If you wish to use PHP Markdown with another text filter function
|
|||
|
built to parse HTML, you should filter the text *after* the Markdown
|
|||
|
function call. This is an example with [PHP SmartyPants][psp]:
|
|||
|
|
|||
|
$my_html = SmartyPants(Markdown($my_text));
|
|||
|
|
|||
|
|
|||
|
### With Smarty ###
|
|||
|
|
|||
|
If your program use the [Smarty][sm] template engine, PHP Markdown
|
|||
|
can now be used as a modifier for your templates. Rename "markdown.php"
|
|||
|
to "modifier.markdown.php" and put it in your smarty plugins folder.
|
|||
|
|
|||
|
[sm]: http://smarty.php.net/
|
|||
|
|
|||
|
If you are using MovableType 3.1 or later, the Smarty plugin folder is
|
|||
|
located at `(MT CGI root)/php/extlib/smarty/plugins`. This will allow
|
|||
|
Markdown to work on dynamic pages.
|
|||
|
|
|||
|
|
|||
|
Configuration
|
|||
|
-------------
|
|||
|
|
|||
|
By default, PHP Markdown produces XHTML output for tags with empty
|
|||
|
elements. E.g.:
|
|||
|
|
|||
|
<br />
|
|||
|
|
|||
|
Markdown can be configured to produce HTML-style tags; e.g.:
|
|||
|
|
|||
|
<br>
|
|||
|
|
|||
|
To do this, you must edit the "MARKDOWN_EMPTY_ELEMENT_SUFFIX"
|
|||
|
definition below the "Global default settings" header at the start of
|
|||
|
the "markdown.php" file.
|
|||
|
|
|||
|
|
|||
|
### WordPress-Specific Settings ###
|
|||
|
|
|||
|
By default, the Markdown plugin applies to both posts and comments on
|
|||
|
your WordPress weblog. To deactivate one or the other, edit the
|
|||
|
`MARKDOWN_WP_POSTS` or `MARKDOWN_WP_COMMENTS` definitions under the
|
|||
|
"WordPress settings" header at the start of the "markdown.php" file.
|
|||
|
|
|||
|
|
|||
|
Bugs
|
|||
|
----
|
|||
|
|
|||
|
To file bug reports please send email to:
|
|||
|
<michel.fortin@michelf.ca>
|
|||
|
|
|||
|
Please include with your report: (1) the example input; (2) the output you
|
|||
|
expected; (3) the output PHP Markdown actually produced.
|
|||
|
|
|||
|
If you have a problem where Markdown gives you an empty result, first check
|
|||
|
that the backtrack limit is not too low by running `php --info | grep pcre`.
|
|||
|
See Installation and Requirement above for details.
|
|||
|
|
|||
|
|
|||
|
Version History
|
|||
|
---------------
|
|||
|
|
|||
|
1.0.2 (29 Nov 2013)
|
|||
|
|
|||
|
* Added support for the `tel:` URL scheme in automatic links.
|
|||
|
|
|||
|
<tel:+1-111-111-1111>
|
|||
|
|
|||
|
It gets converted to this (note the `tel:` prefix becomes invisible):
|
|||
|
|
|||
|
<a href="tel:+1-111-111-1111">+1-111-111-1111</a>
|
|||
|
|
|||
|
|
|||
|
1.0.1q (11 Apr 2013):
|
|||
|
|
|||
|
* Fixed a small mistake that could cause the parser to retain an invalid
|
|||
|
state related to parsing links across multiple runs. This was never
|
|||
|
observed (that I know of), but it's still worth fixing.
|
|||
|
|
|||
|
|
|||
|
1.0.1p (13 Jan 2013):
|
|||
|
|
|||
|
* Fixed an issue where some XML-style empty tags (such as `<br/>`) were not
|
|||
|
recognized correctly as such when inserted into Markdown-formatted text.
|
|||
|
|
|||
|
* The following HTML 5 elements are treated as block elements when at the
|
|||
|
root of an HTML block: `article`, `section`, `nav`, `aside`, `hgroup`,
|
|||
|
`header`, `footer`, and `figure`. `svg` too.
|
|||
|
|
|||
|
|
|||
|
1.0.1o (8 Jan 2012):
|
|||
|
|
|||
|
* Silenced a new warning introduced around PHP 5.3 complaining about
|
|||
|
POSIX characters classes not being implemented. PHP Markdown does not
|
|||
|
use POSIX character classes, but it nevertheless trigged that warning.
|
|||
|
|
|||
|
|
|||
|
1.0.1n (10 Oct 2009):
|
|||
|
|
|||
|
* Enabled reference-style shortcut links. Now you can write reference-style
|
|||
|
links with less brakets:
|
|||
|
|
|||
|
This is [my website].
|
|||
|
|
|||
|
[my website]: http://example.com/
|
|||
|
|
|||
|
This was added in the 1.0.2 betas, but commented out in the 1.0.1 branch,
|
|||
|
waiting for the feature to be officialized. [But half of the other Markdown
|
|||
|
implementations are supporting this syntax][half], so it makes sense for
|
|||
|
compatibility's sake to allow it in PHP Markdown too.
|
|||
|
|
|||
|
[half]: http://babelmark.bobtfish.net/?markdown=This+is+%5Bmy+website%5D.%0D%0A%09%09%0D%0A%5Bmy+website%5D%3A+http%3A%2F%2Fexample.com%2F%0D%0A&src=1&dest=2
|
|||
|
|
|||
|
* Now accepting many valid email addresses in autolinks that were
|
|||
|
previously rejected, such as:
|
|||
|
|
|||
|
<abc+mailbox/department=shipping@example.com>
|
|||
|
<!#$%&'*+-/=?^_`.{|}~@example.com>
|
|||
|
<"abc@def"@example.com>
|
|||
|
<"Fred Bloggs"@example.com>
|
|||
|
<jsmith@[192.0.2.1]>
|
|||
|
|
|||
|
* Now accepting spaces in URLs for inline and reference-style links. Such
|
|||
|
URLs need to be surrounded by angle brakets. For instance:
|
|||
|
|
|||
|
[link text](<http://url/with space> "optional title")
|
|||
|
|
|||
|
[link text][ref]
|
|||
|
[ref]: <http://url/with space> "optional title"
|
|||
|
|
|||
|
There is still a quirk which may prevent this from working correctly with
|
|||
|
relative URLs in inline-style links however.
|
|||
|
|
|||
|
* Fix for adjacent list of different kind where the second list could
|
|||
|
end as a sublist of the first when not separated by an empty line.
|
|||
|
|
|||
|
* Fixed a bug where inline-style links wouldn't be recognized when the link
|
|||
|
definition contains a line break between the url and the title.
|
|||
|
|
|||
|
* Fixed a bug where tags where the name contains an underscore aren't parsed
|
|||
|
correctly.
|
|||
|
|
|||
|
* Fixed some corner-cases mixing underscore-ephasis and asterisk-emphasis.
|
|||
|
|
|||
|
|
|||
|
1.0.1m (21 Jun 2008):
|
|||
|
|
|||
|
* Lists can now have empty items.
|
|||
|
|
|||
|
* Rewrote the emphasis and strong emphasis parser to fix some issues
|
|||
|
with odly placed and overlong markers.
|
|||
|
|
|||
|
|
|||
|
1.0.1l (11 May 2008):
|
|||
|
|
|||
|
* Now removing the UTF-8 BOM at the start of a document, if present.
|
|||
|
|
|||
|
* Now accepting capitalized URI schemes (such as HTTP:) in automatic
|
|||
|
links, such as `<HTTP://EXAMPLE.COM/>`.
|
|||
|
|
|||
|
* Fixed a problem where `<hr@example.com>` was seen as a horizontal
|
|||
|
rule instead of an automatic link.
|
|||
|
|
|||
|
* Fixed an issue where some characters in Markdown-generated HTML
|
|||
|
attributes weren't properly escaped with entities.
|
|||
|
|
|||
|
* Fix for code blocks as first element of a list item. Previously,
|
|||
|
this didn't create any code block for item 2:
|
|||
|
|
|||
|
* Item 1 (regular paragraph)
|
|||
|
|
|||
|
* Item 2 (code block)
|
|||
|
|
|||
|
* A code block starting on the second line of a document wasn't seen
|
|||
|
as a code block. This has been fixed.
|
|||
|
|
|||
|
* Added programatically-settable parser properties `predef_urls` and
|
|||
|
`predef_titles` for predefined URLs and titles for reference-style
|
|||
|
links. To use this, your PHP code must call the parser this way:
|
|||
|
|
|||
|
$parser = new Markdwon_Parser;
|
|||
|
$parser->predef_urls = array('linkref' => 'http://example.com');
|
|||
|
$html = $parser->transform($text);
|
|||
|
|
|||
|
You can then use the URL as a normal link reference:
|
|||
|
|
|||
|
[my link][linkref]
|
|||
|
[my link][linkRef]
|
|||
|
|
|||
|
Reference names in the parser properties *must* be lowercase.
|
|||
|
Reference names in the Markdown source may have any case.
|
|||
|
|
|||
|
* Added `setup` and `teardown` methods which can be used by subclassers
|
|||
|
as hook points to arrange the state of some parser variables before and
|
|||
|
after parsing.
|
|||
|
|
|||
|
|
|||
|
1.0.1k (26 Sep 2007):
|
|||
|
|
|||
|
* Fixed a problem introduced in 1.0.1i where three or more identical
|
|||
|
uppercase letters, as well as a few other symbols, would trigger
|
|||
|
a horizontal line.
|
|||
|
|
|||
|
|
|||
|
1.0.1j (4 Sep 2007):
|
|||
|
|
|||
|
* Fixed a problem introduced in 1.0.1i where the closing `code` and
|
|||
|
`pre` tags at the end of a code block were appearing in the wrong
|
|||
|
order.
|
|||
|
|
|||
|
* Overriding configuration settings by defining constants from an
|
|||
|
external before markdown.php is included is now possible without
|
|||
|
producing a PHP warning.
|
|||
|
|
|||
|
|
|||
|
1.0.1i (31 Aug 2007):
|
|||
|
|
|||
|
* Fixed a problem where an escaped backslash before a code span
|
|||
|
would prevent the code span from being created. This should now
|
|||
|
work as expected:
|
|||
|
|
|||
|
Litteral backslash: \\`code span`
|
|||
|
|
|||
|
* Overall speed improvements, especially with long documents.
|
|||
|
|
|||
|
|
|||
|
1.0.1h (3 Aug 2007):
|
|||
|
|
|||
|
* Added two properties (`no_markup` and `no_entities`) to the parser
|
|||
|
allowing HTML tags and entities to be disabled.
|
|||
|
|
|||
|
* Fix for a problem introduced in 1.0.1g where posting comments in
|
|||
|
WordPress would trigger PHP warnings and cause some markup to be
|
|||
|
incorrectly filtered by the kses filter in WordPress.
|
|||
|
|
|||
|
|
|||
|
1.0.1g (3 Jul 2007):
|
|||
|
|
|||
|
* Fix for PHP 5 compiled without the mbstring module. Previous fix to
|
|||
|
calculate the length of UTF-8 strings in `detab` when `mb_strlen` is
|
|||
|
not available was only working with PHP 4.
|
|||
|
|
|||
|
* Fixed a problem with WordPress 2.x where full-content posts in RSS feeds
|
|||
|
were not processed correctly by Markdown.
|
|||
|
|
|||
|
* Now supports URLs containing literal parentheses for inline links
|
|||
|
and images, such as:
|
|||
|
|
|||
|
[WIMP](http://en.wikipedia.org/wiki/WIMP_(computing))
|
|||
|
|
|||
|
Such parentheses may be arbitrarily nested, but must be
|
|||
|
balanced. Unbalenced parentheses are allowed however when the URL
|
|||
|
when escaped or when the URL is enclosed in angle brakets `<>`.
|
|||
|
|
|||
|
* Fixed a performance problem where the regular expression for strong
|
|||
|
emphasis introduced in version 1.0.1d could sometime be long to process,
|
|||
|
give slightly wrong results, and in some circumstances could remove
|
|||
|
entirely the content for a whole paragraph.
|
|||
|
|
|||
|
* Some change in version 1.0.1d made possible the incorrect nesting of
|
|||
|
anchors within each other. This is now fixed.
|
|||
|
|
|||
|
* Fixed a rare issue where certain MD5 hashes in the content could
|
|||
|
be changed to their corresponding text. For instance, this:
|
|||
|
|
|||
|
The MD5 value for "+" is "26b17225b626fb9238849fd60eabdf60".
|
|||
|
|
|||
|
was incorrectly changed to this in previous versions of PHP Markdown:
|
|||
|
|
|||
|
<p>The MD5 value for "+" is "+".</p>
|
|||
|
|
|||
|
* Now convert escaped characters to their numeric character
|
|||
|
references equivalent.
|
|||
|
|
|||
|
This fix an integration issue with SmartyPants and backslash escapes.
|
|||
|
Since Markdown and SmartyPants have some escapable characters in common,
|
|||
|
it was sometime necessary to escape them twice. Previously, two
|
|||
|
backslashes were sometime required to prevent Markdown from "eating" the
|
|||
|
backslash before SmartyPants sees it:
|
|||
|
|
|||
|
Here are two hyphens: \\--
|
|||
|
|
|||
|
Now, only one backslash will do:
|
|||
|
|
|||
|
Here are two hyphens: \--
|
|||
|
|
|||
|
|
|||
|
1.0.1f (7 Feb 2007):
|
|||
|
|
|||
|
* Fixed an issue with WordPress where manually-entered excerpts, but
|
|||
|
not the auto-generated ones, would contain nested paragraphs.
|
|||
|
|
|||
|
* Fixed an issue introduced in 1.0.1d where headers and blockquotes
|
|||
|
preceded too closely by a paragraph (not separated by a blank line)
|
|||
|
where incorrectly put inside the paragraph.
|
|||
|
|
|||
|
* Fixed an issue introduced in 1.0.1d in the tokenizeHTML method where
|
|||
|
two consecutive code spans would be merged into one when together they
|
|||
|
form a valid tag in a multiline paragraph.
|
|||
|
|
|||
|
* Fixed an long-prevailing issue where blank lines in code blocks would
|
|||
|
be doubled when the code block is in a list item.
|
|||
|
|
|||
|
This was due to the list processing functions relying on artificially
|
|||
|
doubled blank lines to correctly determine when list items should
|
|||
|
contain block-level content. The list item processing model was thus
|
|||
|
changed to avoid the need for double blank lines.
|
|||
|
|
|||
|
* Fixed an issue with `<% asp-style %>` instructions used as inline
|
|||
|
content where the opening `<` was encoded as `<`.
|
|||
|
|
|||
|
* Fixed a parse error occuring when PHP is configured to accept
|
|||
|
ASP-style delimiters as boundaries for PHP scripts.
|
|||
|
|
|||
|
* Fixed a bug introduced in 1.0.1d where underscores in automatic links
|
|||
|
got swapped with emphasis tags.
|
|||
|
|
|||
|
|
|||
|
1.0.1e (28 Dec 2006)
|
|||
|
|
|||
|
* Added support for internationalized domain names for email addresses in
|
|||
|
automatic link. Improved the speed at which email addresses are converted
|
|||
|
to entities. Thanks to Milian Wolff for his optimisations.
|
|||
|
|
|||
|
* Made deterministic the conversion to entities of email addresses in
|
|||
|
automatic links. This means that a given email address will always be
|
|||
|
encoded the same way.
|
|||
|
|
|||
|
* PHP Markdown will now use its own function to calculate the length of an
|
|||
|
UTF-8 string in `detab` when `mb_strlen` is not available instead of
|
|||
|
giving a fatal error.
|
|||
|
|
|||
|
|
|||
|
1.0.1d (1 Dec 2006)
|
|||
|
|
|||
|
* Fixed a bug where inline images always had an empty title attribute. The
|
|||
|
title attribute is now present only when explicitly defined.
|
|||
|
|
|||
|
* Link references definitions can now have an empty title, previously if the
|
|||
|
title was defined but left empty the link definition was ignored. This can
|
|||
|
be useful if you want an empty title attribute in images to hide the
|
|||
|
tooltip in Internet Explorer.
|
|||
|
|
|||
|
* Made `detab` aware of UTF-8 characters. UTF-8 multi-byte sequences are now
|
|||
|
correctly mapped to one character instead of the number of bytes.
|
|||
|
|
|||
|
* Fixed a small bug with WordPress where WordPress' default filter `wpautop`
|
|||
|
was not properly deactivated on comment text, resulting in hard line breaks
|
|||
|
where Markdown do not prescribes them.
|
|||
|
|
|||
|
* Added a `TextileRestrited` method to the textile compatibility mode. There
|
|||
|
is no restriction however, as Markdown does not have a restricted mode at
|
|||
|
this point. This should make PHP Markdown work again in the latest
|
|||
|
versions of TextPattern.
|
|||
|
|
|||
|
* Converted PHP Markdown to a object-oriented design.
|
|||
|
|
|||
|
* Changed span and block gamut methods so that they loop over a
|
|||
|
customizable list of methods. This makes subclassing the parser a more
|
|||
|
interesting option for creating syntax extensions.
|
|||
|
|
|||
|
* Also added a "document" gamut loop which can be used to hook document-level
|
|||
|
methods (like for striping link definitions).
|
|||
|
|
|||
|
* Changed all methods which were inserting HTML code so that they now return
|
|||
|
a hashed representation of the code. New methods `hashSpan` and `hashBlock`
|
|||
|
are used to hash respectivly span- and block-level generated content. This
|
|||
|
has a couple of significant effects:
|
|||
|
|
|||
|
1. It prevents invalid nesting of Markdown-generated elements which
|
|||
|
could occur occuring with constructs like `*something [link*][1]`.
|
|||
|
2. It prevents problems occuring with deeply nested lists on which
|
|||
|
paragraphs were ill-formed.
|
|||
|
3. It removes the need to call `hashHTMLBlocks` twice during the the
|
|||
|
block gamut.
|
|||
|
|
|||
|
Hashes are turned back to HTML prior output.
|
|||
|
|
|||
|
* Made the block-level HTML parser smarter using a specially-crafted regular
|
|||
|
expression capable of handling nested tags.
|
|||
|
|
|||
|
* Solved backtick issues in tag attributes by rewriting the HTML tokenizer to
|
|||
|
be aware of code spans. All these lines should work correctly now:
|
|||
|
|
|||
|
<span attr='`ticks`'>bar</span>
|
|||
|
<span attr='``double ticks``'>bar</span>
|
|||
|
`<test a="` content of attribute `">`
|
|||
|
|
|||
|
* Changed the parsing of HTML comments to match simply from `<!--` to `-->`
|
|||
|
instead using of the more complicated SGML-style rule with paired `--`.
|
|||
|
This is how most browsers parse comments and how XML defines them too.
|
|||
|
|
|||
|
* `<address>` has been added to the list of block-level elements and is now
|
|||
|
treated as an HTML block instead of being wrapped within paragraph tags.
|
|||
|
|
|||
|
* Now only trim trailing newlines from code blocks, instead of trimming
|
|||
|
all trailing whitespace characters.
|
|||
|
|
|||
|
* Fixed bug where this:
|
|||
|
|
|||
|
[text](http://m.com "title" )
|
|||
|
|
|||
|
wasn't working as expected, because the parser wasn't allowing for spaces
|
|||
|
before the closing paren.
|
|||
|
|
|||
|
* Filthy hack to support markdown='1' in div tags.
|
|||
|
|
|||
|
* _DoAutoLinks() now supports the 'dict://' URL scheme.
|
|||
|
|
|||
|
* PHP- and ASP-style processor instructions are now protected as
|
|||
|
raw HTML blocks.
|
|||
|
|
|||
|
<? ... ?>
|
|||
|
<% ... %>
|
|||
|
|
|||
|
* Fix for escaped backticks still triggering code spans:
|
|||
|
|
|||
|
There are two raw backticks here: \` and here: \`, not a code span
|
|||
|
|
|||
|
|
|||
|
1.0.1c (9 Dec 2005)
|
|||
|
|
|||
|
* Fixed a problem occurring with PHP 5.1.1 due to a small
|
|||
|
change to strings variable replacement behaviour in
|
|||
|
this version.
|
|||
|
|
|||
|
|
|||
|
1.0.1b (6 Jun 2005)
|
|||
|
|
|||
|
* Fixed a bug where an inline image followed by a reference link would
|
|||
|
give a completely wrong result.
|
|||
|
|
|||
|
* Fix for escaped backticks still triggering code spans:
|
|||
|
|
|||
|
There are two raw backticks here: \` and here: \`, not a code span
|
|||
|
|
|||
|
* Fix for an ordered list following an unordered list, and the
|
|||
|
reverse. There is now a loop in _DoList that does the two
|
|||
|
separately.
|
|||
|
|
|||
|
* Fix for nested sub-lists in list-paragraph mode. Previously we got
|
|||
|
a spurious extra level of `<p>` tags for something like this:
|
|||
|
|
|||
|
* this
|
|||
|
|
|||
|
* sub
|
|||
|
|
|||
|
that
|
|||
|
|
|||
|
* Fixed some incorrect behaviour with emphasis. This will now work
|
|||
|
as it should:
|
|||
|
|
|||
|
*test **thing***
|
|||
|
**test *thing***
|
|||
|
***thing* test**
|
|||
|
***thing** test*
|
|||
|
|
|||
|
Name: __________
|
|||
|
Address: _______
|
|||
|
|
|||
|
* Correct a small bug in `_TokenizeHTML` where a Doctype declaration
|
|||
|
was not seen as HTML.
|
|||
|
|
|||
|
* Major rewrite of the WordPress integration code that should
|
|||
|
correct many problems by preventing default WordPress filters from
|
|||
|
tampering with Markdown-formatted text. More details here:
|
|||
|
<http://michelf.ca/weblog/2005/wordpress-text-flow-vs-markdown/>
|
|||
|
|
|||
|
|
|||
|
1.0.1a (15 Apr 2005)
|
|||
|
|
|||
|
* Fixed an issue where PHP warnings were trigged when converting
|
|||
|
text with list items running on PHP 4.0.6. This was comming from
|
|||
|
the `rtrim` function which did not support the second argument
|
|||
|
prior version 4.1. Replaced by a regular expression.
|
|||
|
|
|||
|
* Markdown now filter correctly post excerpts and comment
|
|||
|
excerpts in WordPress.
|
|||
|
|
|||
|
* Automatic links and some code sample were "corrected" by
|
|||
|
the balenceTag filter in WordPress meant to ensure HTML
|
|||
|
is well formed. This new version of PHP Markdown postpone this
|
|||
|
filter so that it runs after Markdown.
|
|||
|
|
|||
|
* Blockquote syntax and some code sample were stripped by
|
|||
|
a new WordPress 1.5 filter meant to remove unwanted HTML
|
|||
|
in comments. This new version of PHP Markdown postpone this
|
|||
|
filter so that it runs after Markdown.
|
|||
|
|
|||
|
|
|||
|
1.0.1 (16 Dec 2004):
|
|||
|
|
|||
|
* Changed the syntax rules for code blocks and spans. Previously,
|
|||
|
backslash escapes for special Markdown characters were processed
|
|||
|
everywhere other than within inline HTML tags. Now, the contents of
|
|||
|
code blocks and spans are no longer processed for backslash escapes.
|
|||
|
This means that code blocks and spans are now treated literally,
|
|||
|
with no special rules to worry about regarding backslashes.
|
|||
|
|
|||
|
**IMPORTANT**: This breaks the syntax from all previous versions of
|
|||
|
Markdown. Code blocks and spans involving backslash characters will
|
|||
|
now generate different output than before.
|
|||
|
|
|||
|
Implementation-wise, this change was made by moving the call to
|
|||
|
`_EscapeSpecialChars()` from the top-level `Markdown()` function to
|
|||
|
within `_RunSpanGamut()`.
|
|||
|
|
|||
|
* Significants performance improvement in `_DoHeader`, `_Detab`
|
|||
|
and `_TokenizeHTML`.
|
|||
|
|
|||
|
* Added `>`, `+`, and `-` to the list of backslash-escapable
|
|||
|
characters. These should have been done when these characters
|
|||
|
were added as unordered list item markers.
|
|||
|
|
|||
|
* Inline links using `<` and `>` URL delimiters weren't working:
|
|||
|
|
|||
|
like [this](<http://example.com/>)
|
|||
|
|
|||
|
Fixed by moving `_DoAutoLinks()` after `_DoAnchors()` in
|
|||
|
`_RunSpanGamut()`.
|
|||
|
|
|||
|
* Fixed bug where auto-links were being processed within code spans:
|
|||
|
|
|||
|
like this: `<http://example.com/>`
|
|||
|
|
|||
|
Fixed by moving `_DoAutoLinks()` from `_RunBlockGamut()` to
|
|||
|
`_RunSpanGamut()`.
|
|||
|
|
|||
|
* Sort-of fixed a bug where lines in the middle of hard-wrapped
|
|||
|
paragraphs, which lines look like the start of a list item,
|
|||
|
would accidentally trigger the creation of a list. E.g. a
|
|||
|
paragraph that looked like this:
|
|||
|
|
|||
|
I recommend upgrading to version
|
|||
|
8. Oops, now this line is treated
|
|||
|
as a sub-list.
|
|||
|
|
|||
|
This is fixed for top-level lists, but it can still happen for
|
|||
|
sub-lists. E.g., the following list item will not be parsed
|
|||
|
properly:
|
|||
|
|
|||
|
* I recommend upgrading to version
|
|||
|
8. Oops, now this line is treated
|
|||
|
as a sub-list.
|
|||
|
|
|||
|
Given Markdown's list-creation rules, I'm not sure this can
|
|||
|
be fixed.
|
|||
|
|
|||
|
* Fix for horizontal rules preceded by 2 or 3 spaces or followed by
|
|||
|
trailing spaces and tabs.
|
|||
|
|
|||
|
* Standalone HTML comments are now handled; previously, they'd get
|
|||
|
wrapped in a spurious `<p>` tag.
|
|||
|
|
|||
|
* `_HashHTMLBlocks()` now tolerates trailing spaces and tabs following
|
|||
|
HTML comments and `<hr/>` tags.
|
|||
|
|
|||
|
* Changed special case pattern for hashing `<hr>` tags in
|
|||
|
`_HashHTMLBlocks()` so that they must occur within three spaces
|
|||
|
of left margin. (With 4 spaces or a tab, they should be
|
|||
|
code blocks, but weren't before this fix.)
|
|||
|
|
|||
|
* Auto-linked email address can now optionally contain
|
|||
|
a 'mailto:' protocol. I.e. these are equivalent:
|
|||
|
|
|||
|
<mailto:user@example.com>
|
|||
|
<user@example.com>
|
|||
|
|
|||
|
* Fixed annoying bug where nested lists would wind up with
|
|||
|
spurious (and invalid) `<p>` tags.
|
|||
|
|
|||
|
* Changed `_StripLinkDefinitions()` so that link definitions must
|
|||
|
occur within three spaces of the left margin. Thus if you indent
|
|||
|
a link definition by four spaces or a tab, it will now be a code
|
|||
|
block.
|
|||
|
|
|||
|
* You can now write empty links:
|
|||
|
|
|||
|
[like this]()
|
|||
|
|
|||
|
and they'll be turned into anchor tags with empty href attributes.
|
|||
|
This should have worked before, but didn't.
|
|||
|
|
|||
|
* `***this***` and `___this___` are now turned into
|
|||
|
|
|||
|
<strong><em>this</em></strong>
|
|||
|
|
|||
|
Instead of
|
|||
|
|
|||
|
<strong><em>this</strong></em>
|
|||
|
|
|||
|
which isn't valid.
|
|||
|
|
|||
|
* Fixed problem for links defined with urls that include parens, e.g.:
|
|||
|
|
|||
|
[1]: http://sources.wikipedia.org/wiki/Middle_East_Policy_(Chomsky)
|
|||
|
|
|||
|
"Chomsky" was being erroneously treated as the URL's title.
|
|||
|
|
|||
|
* Double quotes in the title of an inline link used to give strange
|
|||
|
results (incorrectly made entities). Fixed.
|
|||
|
|
|||
|
* Tabs are now correctly changed into spaces. Previously, only
|
|||
|
the first tab was converted. In code blocks, the second one was too,
|
|||
|
but was not always correctly aligned.
|
|||
|
|
|||
|
* Fixed a bug where a tab character inserted after a quote on the same
|
|||
|
line could add a slash before the quotes.
|
|||
|
|
|||
|
This is "before" [tab] and "after" a tab.
|
|||
|
|
|||
|
Previously gave this result:
|
|||
|
|
|||
|
<p>This is \"before\" [tab] and "after" a tab.</p>
|
|||
|
|
|||
|
* Removed a call to `htmlentities`. This fixes a bug where multibyte
|
|||
|
characters present in the title of a link reference could lead to
|
|||
|
invalid utf-8 characters.
|
|||
|
|
|||
|
* Changed a regular expression in `_TokenizeHTML` that could lead to
|
|||
|
a segmentation fault with PHP 4.3.8 on Linux.
|
|||
|
|
|||
|
* Fixed some notices that could show up if PHP error reporting
|
|||
|
E_NOTICE flag was set.
|
|||
|
|
|||
|
|
|||
|
Copyright and License
|
|||
|
---------------------
|
|||
|
|
|||
|
PHP Markdown
|
|||
|
Copyright (c) 2004-2013 Michel Fortin
|
|||
|
<http://michelf.ca/>
|
|||
|
All rights reserved.
|
|||
|
|
|||
|
Based on Markdown
|
|||
|
Copyright (c) 2003-2006 John Gruber
|
|||
|
<http://daringfireball.net/>
|
|||
|
All rights reserved.
|
|||
|
|
|||
|
Redistribution and use in source and binary forms, with or without
|
|||
|
modification, are permitted provided that the following conditions are
|
|||
|
met:
|
|||
|
|
|||
|
* Redistributions of source code must retain the above copyright notice,
|
|||
|
this list of conditions and the following disclaimer.
|
|||
|
|
|||
|
* Redistributions in binary form must reproduce the above copyright
|
|||
|
notice, this list of conditions and the following disclaimer in the
|
|||
|
documentation and/or other materials provided with the distribution.
|
|||
|
|
|||
|
* Neither the name "Markdown" nor the names of its contributors may
|
|||
|
be used to endorse or promote products derived from this software
|
|||
|
without specific prior written permission.
|
|||
|
|
|||
|
This software is provided by the copyright holders and contributors "as
|
|||
|
is" and any express or implied warranties, including, but not limited
|
|||
|
to, the implied warranties of merchantability and fitness for a
|
|||
|
particular purpose are disclaimed. In no event shall the copyright owner
|
|||
|
or contributors be liable for any direct, indirect, incidental, special,
|
|||
|
exemplary, or consequential damages (including, but not limited to,
|
|||
|
procurement of substitute goods or services; loss of use, data, or
|
|||
|
profits; or business interruption) however caused and on any theory of
|
|||
|
liability, whether in contract, strict liability, or tort (including
|
|||
|
negligence or otherwise) arising in any way out of the use of this
|
|||
|
software, even if advised of the possibility of such damage.
|