Permalink
Find file
Fetching contributors…
Cannot retrieve contributors at this time
154 lines (94 sloc) 6.04 KB

WP-Markdown

Contributors: stephenharris
Donate link: http://www.stephenharris.info
Tags: markdown, formatting,prettify,syntax highlighter,code
Requires at least: 3.1
Tested up to: 3.6
Stable tag: 1.5.1

Allows Markdown to be enabled in posts, comments and bbPress forums.

Description

This plug-in allows you to write posts (of any post type) using the Markdown syntax. The plug-in converts the Markdown into HTML prior to saving the post. When editing a post, the plug-in converts it back into Markdown syntax.

The plug-in also allows you to enable Markdown in comments and BBPress forums. In these instances the plug-in adds a toolbar, and preview of the processed Markdown with Prettify syntax highlighter applied (similiar to that used in the Stack Exchange websites such as WordPress Stack Exchange).

WP-Markdown stores the processed HTML, so deactivating the plug-in will not affect your posts, comments or bbPress forums.

Installation

Installation is standard and straight forward.

  1. Upload markdown folder (and all it's contents!) to the /wp-content/plugins/ directory
  2. Activate the plugin through the 'Plugins' menu in WordPress
  3. Go to your Settings > Writing page and enable markdown for the appropriate post types and comments.

Frequently Asked Questions

How do I use Markdown syntax?

For information on how to use Markdown sytnax pleae read: Markdown: syntax.

What happens to the post content if I uninstall the plug-in?

The plug-in uses Markdown to generate the appropriate HTML prior to the post saving to the database. When you edit a post, it is converted back to Markdown syntax. Once the plug-in is uninstalled you'll simply rever to editing the posts' HTML.

How do I embed content?

A clean install of WordPress allows you to (for example) include a YouTube url on a seperate line, whereupon it will automatically embed the video. This is not possible with WP-MarkDown installed (*I tried - I broke more things. But if you manage it, feel free to make a pull-request: https://github.com/stephenharris/WP-MarkDown*).

You'll need to use the [embed] shortcode.

How do I prevent a bit of the page being parsed as MarkDown?

Enclose it in a div tag. It'll be ignored.

How do I allow the contents of a div tag to be parsed as MarkDown?

Use <div markdown="1">.

Screenshots

1. The Markdown toolbar and previewer on a bbPress forum

The Markdown toolbar and previewer on a bbPress forum

2. Plug-in settings, located at the bottom of the Writing settings page

Plug-in settings, located at the bottom of the Writing settings page

3. The Markdown toolbar and previewer on a comment form

The Markdown toolbar and previewer on a comment form

4. Example of Markdown syntax

Example of Markdown syntax

5. The output of the example Markdown

The output of the example Markdown

Changelog

1.5.1

  • Addresses issues with (since withdrawn) 1.5 version

1.5

  • Handle tables. See#35
  • Apply responsive layout issue. See#31
  • Use compressed prettify.js
  • Fixed bug with lists not being escaped
  • Fix textdomain. Change to 'wp-markdown'. Add pot.
  • Fixes incompatability issues with bbPress.

1.4

  • Fixes issue with consecutive shortcodes.
  • Fixes editing bbPress topics/replies on the front end corrupts MarkDown. See #25

1.3

  • Apply kses and balance tags after MD->HTML conversion. See#23
  • Compress scripts and minify icon sprite. See #7
  • Adds 'more' tag to MarkDown editor.
  • Adds support for iframes. See #22.
  • Fixes bug with underscores in shortcodes.
  • Adds support for tbody, tfoot and thead tags
  • Refactoring including renaming of plug-in style & script handles.

1.2

  • Fixes problems with images nested inside links. See #12
  • Ensure prettify is loaded, if needed, on home page. See #6
  • Updated Markdownify
  • Updated Prettify

1.1.6

  • Removes the wpautop/unwpautop functions. If using oembed, use embed shortcodes.
  • Adds public wrapper functions.
  • Remove bbPress front-end tinymce editor if using MarkDown

1.1.5

  • Fixes bug introduced in 1.1.4 where line breaks are stripped (affects code blocks).

1.1.4

  • Fixes bug where oembed would not work. Thanks ot Michael & Vinicius
  • Adds a filters for MarkDown 'help' text: wpmarkdown_help_text
  • Support for MarkDown extra (currently not supported in pagedown previewer)

1.1.3

  • Stable with WordPress 3.4
  • Fixed bug relating title attributes for links and images

1.1.2

  • Fixed bug relating to comments by logged out users

1.1.1

  • Fixed backslash bug

1.1

  • Added option to replace TinyMCE with Markdown help bar on post editor

1.0

  • Initial release

Upgrade Notice

1.1.5

If you have upgraded to 1.1.4, please upgrade to 1.1.5. This release fixes a bug introduced in 1.1.4 (see http://wordpress.org/support/topic/plugin-wp-markdown-breaks-oembed-support)

1.1

  • Added option to enable the Markdown help bar on the backend post editor. Simple check Markdown help bar for 'Post editor' in the settings.