Markdown WikiProcessor Macro Implementation

Description

This macro implements John Gruber's ​Markdown lightweight plain text-to-HTML formatting syntax as a wiki processor macro.

Example of its usage:

{{{#!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").

A table:

First Header  | Second Header
------------- | -------------
Content Cell  | Content Cell
Content Cell  | Content Cell
}}}

Alternatively, enabling the MarkdownFormatter component will render wiki content as Markdown throughout Trac, without needing to wrap the text in a WikiProcessor. See installation for details.

See also:

• John Gruber's ​Markdown.
• ​Python Markdown.
• ​Markdown syntax.

Bugs/Feature Requests

Existing bugs and feature requests for MarkdownMacro are here.

If you have any issues, create a new ticket.

defect	10 / 14
enhancement	6 / 6
task	1 / 1

Download

Download the zipped source from here.

The plugin is also available on ​PyPI.

Source

You can check out MarkdownMacro from here using Subversion, or browse the source​ with Trac.

Installation

First you need to install the ​Python Markdown package. Follow the instructions on the Web site.

General instructions on installing Trac plugins can be found on the TracPlugins page.

Enable the macro in your trac.ini file:

[components]
tracmarkdown.macro.markdownformatter = disabled
tracmarkdown.macro.markdownmacro = enabled

If you want to use markdown without wrapping the text in a WikiProcessor:

[components]
tracmarkdown.macro.markdownformatter = enabled
tracmarkdown.macro.markdownmacro = disabled

The markdownformatter and markdownmacro components are mutually exclusive and should not be both enabled.

Recent Changes

18423 by Cinc-th on 2021-06-03 08:23:45

MarkdownMacro: use Markdown < 3.2 install requirement only for Python 2. For Python 3 (Trac >1.4.x) any release will do.

18422 by Cinc-th on 2021-06-02 06:02:38

MarkdownMacro: removed debug print statement.

18417 by Cinc-th on 2021-06-01 10:33:33

MarkdownMacro: new preview renderer for *.md files. To render README.md und Install.md properly change the following in trac.ini.

[mimeviewer]
mime_map_patterns = text/plain:README(?!(\.md|\.rst))|INSTALL(\.md|\.rst)|COPYING.*

Closes #11743

(more)

Author/Contributors

Author: dwclifton (Macro/Processor package, setup, documentation)
Maintainer: Cinc-th
Contributors:

• ​John Gruber
• ​Yuri Takhteyev, et al.
• Alex Mizrahi alias killer_storm