Display README files, especially Markdown, in Browse Source


This is a plugin to display README files in Browse Source directory listings. It automatically parses markdown files (.md) into HTML. This is useful if you're writing markdown (ultimately targeting HTML) and want a quick preview.

Bugs/Feature Requests

Please use GitHub for any issues you have with this plugin.


Download the zipped source from here.


You can clone from here using git, or browse the source on GitHub.


Deploy to a specific Trac environment:

cd /path/to/pluginsource
python bdist_egg
cp dist/*.egg /path/to/projenv/plugins

Enable the plugin in your trac.ini file:

readme_renderer.* = enabled


A possible configuration in trac.ini:

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/ortext/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 the expected behaviour.

For more information, please follow documentation on how to install Trac plugins.


Author: Southen?
Maintainer: Southen?
Contributors: osimons

Last modified 2 years ago Last modified on Mar 24, 2022, 7:48:45 AM