Contents
Trac Renderer for Asciidoc pages using Asciidoctor
Description
This is a plugin for rendering AsciiDoc source files to HTML when browsing the repository. AsciiDoc offers a plain-text syntax, embellished with markup, that's designed for humans to read, write and edit in raw form.
To use this plugin install Asciidoctor and enable the plugin as usual. Asciidoctor itself is MIT licensed.
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 here.
If you have any issues, create a new ticket.
defect |
1 / 1 |
|
---|---|---|
enhancement |
0 / 1 |
Download
Download the zipped source from here.
Source
You can check out TracAsciidoctorPlugin from here using Subversion, or browse the source with Trac.
Installation
General instructions on installing Trac plugins can be found on the TracPlugins page.
The simplest way to install it is using easy_install
:
easy_install https://trac-hacks.org/svn/tracasciidoctorplugin/1.0/
This plugin uses asciidoctor so it needs to be installed on your machine. 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
under the [components]
subheading:
[components] 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:
[mimeviewer] mime_map = text/asciidoc:adoc:asc:asciidoc
Recent Changes
Author/Contributors
Author: sto
Maintainer: Sergio Talens-Oliag
Contributors: