https://github.com/noamt/bitbucket-asciidoctor-addon
An Asciidoctor add-on for Atlassian Connect
https://github.com/noamt/bitbucket-asciidoctor-addon
Last synced: about 1 month ago
JSON representation
An Asciidoctor add-on for Atlassian Connect
- Host: GitHub
- URL: https://github.com/noamt/bitbucket-asciidoctor-addon
- Owner: noamt
- License: apache-2.0
- Created: 2015-11-24T22:50:07.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-10-31T09:56:09.000Z (over 6 years ago)
- Last Synced: 2025-03-30T16:05:51.543Z (2 months ago)
- Language: JavaScript
- Size: 11.7 KB
- Stars: 10
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.asciidoc
- License: LICENSE
Awesome Lists containing this project
README
= Asciidoctor for Atlassian BitBucket =
=== Features ===
. Displays an Asciidoc README (if exists) on the repository overview page.
. 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:
. Git
. Node.js
. npm
. ngrok
Then, based on the official link:https://developer.atlassian.com/bitbucket/guides/getting-started.html[instructions]:
. Clone the repository and enter the directory.
. Run ```npm install``.
. Edit ```credentials.json``` with your BitBucket cloud credentials.
. Run:
[source,bash]
----
ngrok 3000
----
. In your BitBucket cloud account:
.. Add a new Oauth consumer with the ```ngrok``` HTTPS address as the consumer callback URL.
.. Grant repository read permissions to the new Oauth consumer.
. Copy the Oauth consumer key to ```consumerKey``` in ```config.json```.
. Open a new shell to the cloned directory and run:
[source,bash]
----
# 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
----