[[PageOutline(2-5,Contents,pullout)]]
= Display README files, especially Markdown, in Browse Source

== Description ==

Plugin to display README files in Browse Source directory listings, and preview .md files as rendered Markdown

== Bugs/Feature Requests ==

Please use [https://github.com/Southen/trac-readme-plugin/issues GitHub] for any issues you have with this plugin.

== Download ==

Download the zipped source from [https://github.com/Southen/trac-readme-plugin/archive/master.zip here].

== Source ==

You can clone from [https://github.com/Southen/trac-readme-plugin.git here] using git, or [https://github.com/Southen/trac-readme-plugin browse the source] on GitHub.

== Installation ==

Deploy to a specific Trac environment:
{{{
$ cd /path/to/pluginsource
$ python setup.py bdist_egg
$ cp dist/*.egg /path/to/projenv/plugins
}}}

Enable plugin in trac.ini:
{{{
[components]
readme_renderer.* = enabled
}}}

Configuration in trac.ini:
{{{
[mimeviewer]
mime_map = ...,text/x-trac-wiki:wiki,text/x-markdown:md
mime_map_patterns = text/plain:README:INSTALL:COPYING
}}}

Appending `text/x-trac-wiki:wiki` and/or`text/x-markdown:md` to `mime_map` will render the appropriate file extensions as wiki and markdown files respectively in file previews.
The default setting for `mime_map_patterns` forces all README files to be plain text, you may need to replace `|` with `:` or remove the `.*` to get expected behaviour.

For more information, please follow [http://trac.edgewall.org/wiki/TracPlugins#InstallingaTracPlugin documentation] on how to install Trac's plugins.

== Recent Changes

[[ChangeLog(readmeplugin, 3)]]

== !Author/Contributors

'''Author:''' [wiki:Southen] [[BR]]
'''Maintainer:''' [wiki:Southen] [[BR]]
'''Contributors:''' [wiki:osimons] [[BR]]