[[PageOutline(2-5,Contents,pullout)]]

= Trac Renderer for asciidoc pages using Asciidoctor

== Description

A plugin for rendering asciidoc source files to HTML when browsing the repository.

To use install [http://asciidoctor.org/ Asciidoctor] and enable the plugin as usual.

Note that the plugin only renders files using the browser, I don't plan to add support for the wiki unless someone asks for it.

== !Bugs/Feature Requests

Existing bugs and feature requests for TracAsciidoctorPlugin are 
[report:9?COMPONENT=TracAsciidoctorPlugin here].

If you have any issues, create a 
[http://trac-hacks.org/newticket?component=TracAsciidoctorPlugin new ticket].

== Download

Download the zipped source from [export:tracasciidoctorplugin here].

== Source

You can check out TracAsciidoctorPlugin from [http://trac-hacks.org/svn/tracasciidoctorplugin here] using Subversion, or [source:tracasciidoctorplugin browse the source] with Trac.

== Installation

General instructions on installing Trac plugins can be found on the [TracPlugins#InstallingaTracplugin TracPlugins] page.

The simplest way to install it is using easy_install:
{{{
easy_install http://trac-hacks.org/svn/tracasciidoctorplugin/1.0/
}}}
This plugin uses asciidoctor so it needs to be installed on your machine and if it is not in the usual place of /usr/bin/asciidoctor you can specify its location in the trac.ini file:
{{{
asciidoctor_path = /your_path/asciidoctor
}}}
You will need to enable it in trac.ini:
{{{
tracasciidoctor.* = enabled
}}}


It will render pages with `svn:mime-type` property set to `text/asciidoc` or `text/x-asciidoc`.


If you want to render pages without setting the `mime-type` a good option is to add extensions to the `[mimeviewer]` section:
{{{
mime_map = text/asciidoc:adoc:asc:asciidoc
}}}

== Recent Changes

[[ChangeLog(tracasciidoctorplugin, 3)]]

== !Author/Contributors

**Author:** [wiki:sto] [[BR]]
**Maintainer:** [[Maintainer]] [[BR]]
**Contributors:**