Install

You can install the extension from your browser’s Web Store or a local copy of the extension.

Install from a web store

  1. Install the Extension on your browser using the image links below.

    Image link to the Chrome, Chromium or Brave Web Store
    Chrome
    Image link to the Firefox Web Store
    Firefox
    Image link to the Opera Web Store
    Opera
    Image link to the Microsoft Edge Web Store
    Edge
    You can also search your browser’s Web Store for the Asciidoctor.js Live Preview extension.

  2. To preview local files on Chrome, Edge, Chromium-based, Brave or Opera browsers, you need to grant filesystem access to the extension:

    1. Type the URL chrome://extensions into the address bar and press Enter

    2. Type asciidoctor into the extension search bar then when the Asciidoctor Browser Extension block is visible, click its Details button.

    3. Check Allow access to file URLs

      If the plugin does not view a local file, check the above setting.

  3. You have now installed the extension, and can open local or remote .adoc, .ad, .asc, .asciidoc files in your browser

    Enjoy!

There are known issues with Firefox. See Known Firefox Issues.

Local installations

Local installations are for users and developers when:

  • Your machine does not have access to the internet or extension stores

  • You are testing an unreleased (locally built) version

Load your local copy of the extension to your browser using the appropriate section below.

Chrome, Edge, Chromium-based, Brave or Opera

  1. Open the chrome://extensions page and enable the Developer mode option

  2. Click button Load unpacked and select the extension app directory of the unpacked extension files

To see your changes, click the Reload (Ctrl+R) link in chrome://extensions page. If you want to create a Pack extension then make a zip file of the extension app directory.

Firefox

  1. Click the button Load Temporary Add-on on the about:debugging page

  2. Select the manifest file in the app directory

To see your changes, click the Reload link in about:debugging page.