Changes between Version 5 and Version 6 of ReadmePlugin


Ignore:
Timestamp:
Jul 12, 2016, 8:54:14 AM (8 years ago)
Author:
figaro
Comment:

Further cosmetic changes

Legend:

Unmodified
Added
Removed
Modified
  • ReadmePlugin

    v5 v6  
    55== Description
    66
    7 This is plugin to display README files in Browse Source directory listings, and preview .md files as rendered Markdown.
     7This 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.
    88
    99== Bugs/Feature Requests
     
    2828}}}
    2929
    30 Enable plugin in `trac.ini`:
     30Enable plugin in your `trac.ini` file:
    3131{{{#!ini
    3232[components]
     
    3535
    3636Configuration in `trac.ini`:
    37 {{{
    38 #!ini
     37{{{#!ini
    3938[mimeviewer]
    4039mime_map = ...,text/x-trac-wiki:wiki,text/x-markdown:md
     
    4342
    4443Appending `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.
    45 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.
     44The 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.
    4645
    4746For more information, please follow [TracPlugins#InstallingaTracPlugin documentation] on how to install Trac plugins.