#pragma section-numbers 2
= Markdown Extension =

Markdown Extension for hgweb.

<<TableOfContents>>

== Status ==

'''This extension is not distributed with Mercurial.'''

''Author: '' ''Chris Eldredge''

Repository: ''[[https://bitbucket.org/celdredge/hgext.markdown]]''

== Overview ==

Similar to GitHub, this module looks for a file named ReadMe.md or ReadMe.markdown (case insensitive).

A custom theme is provided that displays the formatted contents on the summary (index) view.

In addition to showing formatted information on the summary view, this module replaces the default file view for .md or .markdown files, enabling you to use the WikiLinks extension to support documentation split across several pages.

== Installation ==

 1. Install Python-Markdown (https://python-markdown.github.io/install/)
 1. Clone this repository to /example/hgext.markdown
 1. Add the following to your hgweb config

== Configuration ==
Configure your .hgrc to enable the extension by adding following lines:

{{{
[web]
templates = /example/hgext.markdown/templates
style = markdown
#optional; 'tip' is default value.
markdown.changeid = tip

[extensions]
hgext.markdown=/example/hgext.markdown
}}}

== See also ==

----
CategoryExtensionsByOthers