Skip to content

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

Notifications You must be signed in to change notification settings

Southen/trac-readme-plugin

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 

Repository files navigation

trac-readme-plugin

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

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

License

Copyright (c) 2014, Sebastian Southen
All rights reserved.

Based on ReposReadMePlugin Copyright (c) 2009, CodeResort.com - BV Network AS

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  3. The name of the author may not be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR `AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

About

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

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published