ReadMe.markdown @ 1d3416da68e0

Markdown Extension for hgweb
============================

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

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 enables any
other markdown content to be rendered using the url pattern `/repo/markdown/changeid/WikiPage.md`.

##Install##

1. Install Python-Markdown (http://packages.python.org/Markdown/install.html)
1. Clone this repository to /example/hgext.markdown
1. Add the following to your hgweb config

config:

	[web]
	templates = /example/hgext.markdown
	style = markdown
	
	[extensions]
	hgext.markdown=/example/hgext.markdown


##Usage with TortoiseHg##

If you want to use this extension with TortoiseHg, you will need to
obtain the python markdown package (http://packages.python.org/Markdown/)
and uncomment the section in [\_\_init\_\_.py](\_\_init\_\_.py) that adjusts the python module path.

##Preview##

You can preview changes before committing them by browsing to `/repo/markdown/_preview/ReadMe.markdown`.
The `_preview` keyword makes this extension look for content in the working copy.