Skip to content
This repository has been archived by the owner on Aug 6, 2020. It is now read-only.

Commit

Permalink
More description of changes in README
Browse files Browse the repository at this point in the history
  • Loading branch information
egil committed Jul 9, 2011
1 parent d028dcb commit 0a771b5
Showing 1 changed file with 31 additions and 2 deletions.
33 changes: 31 additions & 2 deletions README.markdown
Original file line number Diff line number Diff line change
@@ -1,7 +1,36 @@
# PHP Markdown Extra Extended #

An fork of the [PHP Markdown (Extra) project](http://michelf.com/projects/php-markdown/), extended with extra syntax, especially focused on adding support adding attributes to outputted HTML for better support for HTML5.
An fork of the [PHP Markdown (Extra) project](http://michelf.com/projects/php-markdown/)(PME), extended with extra syntax, especially focused on adding support for more HTML attributes to outputted HTML, and for outputting HTML5.


## Changes from PHP Markdown ##

### Line break generates a `<br />` ###
### Line break generates a `<br />` (modification) ###
In PME, when you want to insert a `<br />` break tag using Markdown, you end a line with two or more spaces, then type return. This turned out to be more annoying than helpful in my projects, so now you just have to type return. This is also how Markdown works here on GitHub.

Two returns does not insert a `<br />`, but instead creates a new paragraph as usual.

### Support for `cite` attribute on blockquotes (addition) ###
It is now possible to add the optional `cite` attribute to the `blockquote` element.

The new, optional, syntax is:

```markdown
> [cite url] Cite content follows
```

The existing rules for and [formatting options](http://daringfireball.net/projects/markdown/syntax#blockquote) for blockquotes still apply.

#### Example:

```markdown
> (http://www.whatwg.org/specs/web-apps/current-work/multipage/grouping-content.html#the-blockquote-element) Content inside a [blockquote](http://www.whatwg.org/specs/web-apps/current-work/multipage/grouping-content.html#the-blockquote-element) must be quoted from another source, whose address, if it has one, may be cited in the `cite` attribute.
```

Will result in the following HTML:

```
<blockquote cite="http://www.whatwg.org/specs/web-apps/current-work/multipage/grouping-content.html#the-blockquote-element">
<p>Content inside a <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/grouping-content.html#the-blockquote-element">blockquote</a> must be quoted from another source, whose address, if it has one, may be cited in the `cite` attribute.
</p>
</blockquote>

0 comments on commit 0a771b5

Please sign in to comment.