[[PageOutline(2-5,Contents,pullout)]]
= Markdown !WikiProcessor Macro Implementation =

== Description ==

The !MarkdownMacro package implements John Gruber's [http://daringfireball.net/projects/markdown/ Markdown]
lightweight plain text-to-HTML formatting syntax as a [WikiProcessors WikiProcessor] macro. The original
code is courtesy of Alex Mizrahi aka [#SeeAlso killer_storm]. I simply added a little robustness to the error 
checking, documented the package, created setup.py and this README, and registered it with
[MarkdownMacro Trac Hacks].

== Installation ==

First you need to install [http://freewisdom.org/projects/python-markdown/ Python Markdown].
Follow the instructions on the Web site.

Then download the attached [https://github.com/dwclifton/tracmarkdownmacro/zipball/master zipfile], unpack it to a temporary location,
visit the `0.11` directory and run:

{{{
python setup.py bdist_egg
cp dist/*.egg /trac/env/Project/plugins
}}}

== Configuration ==

Enable the macro in:

/trac/env/Project/conf/trac.ini:

{{{
[components]
Markdown.* = enabled
}}}

You may have to restart your Web server.

== Example ==

{{{
{{{
#!Markdown

# RGB

+ Red
+ Green
+ Blue

## Source Code

    from trac.core import *
    from trac.wiki.macros import WikiMacroBase
    from trac.wiki.formatter import Formatter

An example [link](http://example.com/ "With a Title").
}}}
}}}

== Source ==

 * Browse the source at: [http://github.com/dwclifton/tracmarkdownmacro/tree/master GitHub].
 * Public clone URL:
{{{
git clone git://github.com/dwclifton/tracmarkdownmacro.git
}}}

== See Also ==

 * John Gruber's [http://daringfireball.net/projects/markdown/ Markdown]
 * [http://www.freewisdom.org/projects/python-markdown/ Python Markdown]
 * [http://trac-hacks.org/attachment/ticket/353/Markdown.py Markdown.py] by Alex Mizrahi aka killer_storm 
 * [http://daringfireball.net/projects/markdown/syntax Markdown syntax]

== Bugs/Feature Requests == 

Existing bugs and feature requests for MarkdownMacro are 
[query:status!=closed&component=MarkdownMacro&order=priority here].

If you have any issues, create a 
[/newticket?component=MarkdownMacro&owner=dwclifton new ticket].

== Recent Changes ==

[[ChangeLog(markdownmacro, 3)]]

== Author/Contributors ==

 * '''Author:''' [wiki:dwclifton] (Macro/Processor package, setup, documentation)
 * '''Maintainer:''' [wiki:dwclifton]
 * '''Contributors:'''
  * [http://daringfireball.net/colophon/ John Gruber]
  * [http://www.freewisdom.org/projects/python-markdown/Credits Yuri Takhteyev, et al.]
  * Alex Mizrahi alias [http://trac-hacks.org/attachment/ticket/353/Markdown.py killer_storm]
  * The Trac and Python development community