Surge-ee / Surgedown

A Markdown fieldtype
17 stars 3 forks source link

ExpressionEngine Markdown Fieldtype.

Note: This field is in early development, but currently highly functional. Community support welcome and will be given credit.

This is a Markdown custom field for ExpressionEngine. It updates as you type to display the rendered Markdown, giving you instant feedback on your output.

Markdown Field

Features:

  1. Comes with a default styesheet for the Markdown preview pane.
  2. Users can change the default stylesheet to a custom CSS file.
  3. Users can select a stylesheet per custom field - Make the markdown output look and feel just like the front-end!
  4. Matrix compatible!

Usage:

  1. Install into themes/third_party and expressionengine/third_party as usual
  2. Install Module and Fieldtype from Add-Ons area in Admin
  3. Use Markdown fieldtype, either alone or within Matrix
  4. Module tag: {exp:markdown:toHTML}content{/exp:markdown:toHTML}

Example Usage:

{exp:markdown:toHTML}
### This is an h3 tag

1. This is
2. A numbered list
3. Of fun and excitement!

And this will show as a paragraph
{/exp:markdown:toHTML}

To Do:

  1. Get rid of AJAX, replace with client-side Markdown parser. Suggestions very welcome.

Change Log

1.2

1.1

1.0

0.5 Initial Release. Somewhat broken. Well, very broken.

Credits

Idea for fieldtype and default CSS for Markdown provided by Mou.