Introduction

An add-on for Atlassian Bitbucket Server to render AsciiDoc files in the source view panel.

Installation

Until version 3.x.x this plugin was available in the Atlassian Marketplace and was installed directly in Bitbucket Server 5.x using the Universal Plugin Manager (UPM), see here for details. However, starting with the version 6.x, its development wasn’t very active anymore. So it hadn’t been updated to include pull-requests related to the version 6.x of Bitbucket Server.

This fork of the initial project is meant to reintegrate the pull-requests in order to release a version that is compatible with Bitbucket versions > 6.x

Manual installation into your Bitbucket server must be achieved. The release files can be found on this GitHub

Releases

5.x.x

The 5.x.x versions are for Bitbucket Server >= 7.8.0

5.0.0 (2020-11-xx)

This version includes the following changes:

• Upgrade to Bitbucket Server 7.8.0

4.x.x

The 4.x.x versions are for Bitbucket Server >= 6.0.0

4.0.1 (2019-11-xx)

This version includes the following changes:

• Upgrades Asciidoctor.JS to 2.0.3

• Upgrades MathJAX to 2.7.6

• Upgrades Highlight.JS to 9.16.2 and supports highlighting of additional languages

4.0.0 (2019-11-xx)

This version includes the following changes:

• Fix: Bitbucket version 6

3.x.x

The 3.x.x versions are for Bitbucket Server >= 5.0.0

3.1.2 (2017-11-18)

This version includes the following changes:

• Fix: Broken relative links

3.1.1 (2017-11-15)

This version includes the following changes:

• Fix: Broken links in TOC

3.1.0 (2017-10-28)

This version includes the following changes:

• Improved support for file include directives

• Support for env-bitbucket and env:`bitbucket` document attributes for conditional rendering, see also http://asciidoctor.org/docs/user-manual/#conditional-preprocessor-directives

3.0.0 (2017-05-07)

This version includes the following changes:

• Compatibility with Bitbucket 5.0.0

2.x.x

The 2.x.x versions are for Bitbucket Server >= 4.0.0 and < 5.0.0

2.4.2 (2017-11-18)

This version includes the following changes:

• Fix: Broken relative links

2.4.1 (2017-11-15)

This version includes the following changes:

• Fix: Broken links in TOC

2.4.0 (2017-10-28)

This version includes the following changes:

• Improved support for file include directives

• Support for env-bitbucket and env:`bitbucket` document attributes for conditional rendering, see also http://asciidoctor.org/docs/user-manual/#conditional-preprocessor-directives

2.3.2 (2016-11-13)

This version includes the following changes:

• Fix: Image includes not correctly rendered for non-default branches

2.3.1 (2016-06-10)

This version includes the following changes:

• Fix: Correct handling of file extensions

2.3.0 (2016-02-13)

This version includes the following changes:

• Syntax highlighting for AsciiMath and LaTeX syntax using MathJax. Thanks to stuwhite.

• Update to asciidoctor.js 1.5.4

• Update to highlight.js 9.1.0

2.2.0 (2016-02-06)

This version includes the following changes:

• Rendering of relative image locations

2.1.0 (2016-01-06)

This version includes the following changes:

• Syntax highlighting using highlight.js

• Improved layout to be closer to Bitbucket Server Markdown support

2.0.0 (2015-12-21)

This is the first release of the add-on. It provides the following features:

• Rendering of AsciiDoc documents in the source view

• Usage of asciidoctor.js 1.5.3-preview.5

1.x.x

The 1.x.x versions were originally reserved for Bitbucket Server < 4.0.0. No releases planned anymore.

License

   Copyright 2015 Christian Galsterer

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

Contribute

Install the Atlassian SDK, following the instructions found here.

The sdk comes with a preconfigured maven, with a settings file pointing to atlassian repositories, either use this maven (atlas-mvn) directly, or within your IDE, you can tell to use the atlassian shipped maven distribution here <atlassian-plugin-sdk-home>/apache-maven-<mvn version>. For more information, read Atlassian SDK guide to work with maven.

In IntelliJ, it’s possible to change the maven home here:

Preferences | Build, Execution, Deployment | Build Tools | Maven

If set correctly, the project should be imported without any issue.

• Run bitbucket locally with atlas-run --product bitbucket

• Navigate to http://localhost:7990/bitbucket

• Login with admin / admin

• Interact with the default project:

  • git clone http://localhost:7990/bitbucket/scm/project_1/rep_1.git rep_1

  • git add demo.adoc

  • git commit --message="adds asciidoc demo file"

  • git push

Also take a look at these documentation from Atlassian SDK

• https://developer.atlassian.com/server/framework/atlassian-sdk/set-up-the-atlassian-plugin-sdk-and-build-a-project/

• https://developer.atlassian.com/server/framework/atlassian-sdk/frequently-used-commands/

• Automatic plugin reinstallation with QuickReload

• https://developer.atlassian.com/server/framework/atlassian-sdk/modify-the-plugin-using-quickreload/