/bitbucket-asciidoctor-addon

An Asciidoctor add-on for Atlassian Connect

Primary LanguageJavaScriptApache License 2.0Apache-2.0

Asciidoctor for Atlassian BitBucket

Features

  1. Displays an Asciidoc README (if exists) on the repository overview page.

  2. Adds an Asciidoc file viewer to the source code browser.

Usage

The addon is still under developement and has not been included in the Atlassian Market yet, but can be used in development mode.

To setup you will need:

  1. Git

  2. Node.js

  3. npm

  4. ngrok

Then, based on the official instructions:

  1. Clone the repository and enter the directory.

  2. Run `npm install.

  3. Edit credentials.json with your BitBucket cloud credentials.

  4. Run:

ngrok 3000

  1. In your BitBucket cloud account:

    1. Add a new Oauth consumer with the ngrok HTTPS address as the consumer callback URL.

    2. Grant repository read permissions to the new Oauth consumer.

  2. Copy the Oauth consumer key to consumerKey in config.json.

  3. Open a new shell to the cloned directory and run:

# Substitue the base URL with the one you used as the callback URL. Pay attention to maintain the trailing slash
AC_LOCAL_BASE_URL=https://2c57c047.ngrok.com/ node app.js