🐺 An add-on for Mozilla Firefox that converts AsciiDoc files to HTML directly in the browser using Asciidoctor.js.
JavaScript CSS
Latest commit fb2598e Apr 4, 2016 @Mogztter Mogztter Prepare version 0.5.4
Permalink
Failed to load latest commit information.
data
img Update the README Feb 12, 2015
lib Resolves #31, Remove sanitize Feb 11, 2016
.gitignore Adds .gitignore Feb 1, 2016
LICENSE
README.adoc Switch to jpm Apr 5, 2015
contributing-code.adoc Adds instruction on how to upgrade Font Awesome Feb 7, 2016
icon.png Relative icon paths do not work with jpm Jul 5, 2015
icon64.png Relative icon paths do not work with jpm Jul 5, 2015
package.json

README.adoc

asciidoctor-firefox-addon, Asciidoctor Firefox Addon

This project uses Asciidoctor.js to render AsciiDoc as HTML inside Firefox!

Usage

  1. Install the extension from the Firefox Add-ons site or from the GitHub latest release page. When you download the xpi file, if Firefox downloads it instead of directly installing it, just drag and drop it on Firefox

  2. Open local or remote .ad, .adoc, .asc, .asciidoc file in Firefox

  3. Click on the Asciidoctor Live Preview button in the toolbar (button with an A icon) to activate or deactivate the rendering.

asciidoctor preview enabled
Figure 1. An asciidoc file opened in firefox with HTML preview
asciidoctor preview disabled
Figure 2. An asciidoc file opened in firefox without HTML preview

Local build

To manually build the extension bundle (.xpi) from the source you need to install jpm.

$ npm install jpm -g

Then execute the command jpm xpi from the add-on’s directory:

$ jpm xpi

This command will produce an .xpi file. You can simply drag and drop it on Firefox to install the Add-on.

Copyright © 2013 Guillaume Grossetie. Free use of this software is granted under the terms of the MIT License.

See the LICENSE file for details.