Git Product home page Git Product logo

bitbucket-asciidoc-plugin's Introduction

Introduction

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

Installation

The plugin is available in the Atlassian Marketplace and can be installed directly in Bitbucket Server using the Universal Plugin Manager (UPM), see here for details.

Releases

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:

3.1.1 (2017-11-15)

This version includes the following changes:

3.1.0 (2017-10-28)

This version includes the following changes:

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:

2.4.1 (2017-11-15)

This version includes the following changes:

2.4.0 (2017-10-28)

This version includes the following changes:

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:

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.

bitbucket-asciidoc-plugin's People

Contributors

christiangalsterer avatar takluyver avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

bitbucket-asciidoc-plugin's Issues

AsciiDoc 3.1.1: Inline links are broken

Hello,

Using Bitbucket 5.5..1, with AsciiDoc 3.1.1, the inline link is incorrect. If you hover over a link, the PATH will be <path>/#<anchor name>?at=/refs/heads/master. You will be presented the folder list after clicking on this link. In AsciiDoc 3.0.0, if you hover over a link, the PATH will be <path>/<filename>#<anchor>, Clicking on this link, the target is presented.

Attached is a sample asciidoc file.

Thank-you!
sample_asciidoc.txt

Image includes do not seem to be included in non-default branches

  1. I have a master as my default branch
  2. I push up some .adoc with some image::[] blocks and some .pngs to my-branch
  3. I view the new rendered page

the images do not seem to be included in the rendering of my-branch.
It looks like they are only included when merged into the default branch.

Images stored in git lfs are not referenced correctly and are not rendered

Images (and potentially other files) that are stored in git lfs aren't linked to correctly; it appears that the "&raw" extension to the url doesn't actually point (or redirect) to the actual image. If the image is browsed to directly using the BitBucket Server interface, the "Raw File" link is actually some kind of REST API call to the associated lfs server.

Not sure if this is even an issue that can be (easily?) solved, but given the prevalence of git lfs, thought I'd raise it anyway!

Thanks!

Relative images are not resolved

Image references like

image::sunset.jpg[]

are not resolved. There is a raw display mode for files in Bitbucket but the URL but those are not relative to the asciidoc document. Hence images are not displayed.

File includes are not working on bitbucket. Part 2

Hey.
Based on #9 .

I writing doc on my project with asciidoc.

I could write:

---
include::dir/file[tag=tag1]
---

But when viewed on our bitbucket server, it gets translated to:

link:dir/file[]

We used plugin version: 3.1.2.

Could you please suggest a workaround?

Incompatible with Bitbucket Data Center

The latest UPM update (3.0) marks this plugin is not compatible with the following text:

The currently installed app was a part of the deprecated Data Center program and the app version is now not Data Center compatible. Please update the app to a Data Center version.

According to Atlassian:

The latest UPM update (3.0.0) contains Data Center compatibility messaging, which is why you’re now seeing these messages.
You’re seeing these as Atlassian has launched a new class for marketplace data center to test if the add-ons are DC compatible. This is to ensure that those add-ons are not compromising performance of the instance. Please refer to the full announcement here A new class of Marketplace app has arrived.
As a result, you will encounter situation where the plugins are marked as incompatible. We’re still approving new apps daily as our vendors and partners update their apps to meet our new Data Center standards. Ultimately, Atlassian recommends you contact the vendor to determine compatibility at scale. For the apps released by us, we are currently working on releasing new versions but that could still take some time.
In most cases, the add-ons should still work and you won’t see any problems (as they’ve been working fine so far), but look out for any updates from vendors.

File includes are not working on bitbucket

Hey,

We are evaluating writing our doc files with asciidoc instead of markdown.

One feature I am excited about is the include possibility.
In asciidoc I could write:

[source,perl]
----
include::lib/dirlist.pl[lines=9..17]
----

Which gets processed and resolved in the IDEA Asciidoc support, but when viewed on our bitbucket server, it gets translated to:

link:lib/dirlist.pl[]

I learned that for example github also does this, probably due to the so called safe mode:

http://asciidoctor.org/docs/user-manual/#running-asciidoctor-securely

But at least the link should work I guess (meaning I'd like to have the actual link not the text "link").

We are running version 2.3.1 of the plugin.

Could you please suggest a workaround?

Links are broken in AsciiDoc version 3.1.0

Hello,

With AsciiDoc version 3.1.0, after clicking on a link in an AsciiDoc document, the link does not go to the correct target but lists the files in the folder. AsciiDoc 3.1.0 determines the link to be /#?at=refs/heads/master which does not exist whereas AsciiDoc 3.0.0 determines the link to be /# which exists and the target is displayed.

Can you please resolve the issue so that the links are followed.

Thanks!

Images not displayed in IE11

this is quite some special behaviour...

in IE11, images are linked without the ?raw parameter at the end which result in those images not being displayed.

A workaround is to add the parameter manually (it doesn't hurt the normal rendering):

image::demo.png?raw[]

Do you know what going on here? I can't see a section in the source where the ?raw paramater is not appended...

Bitbucket 6 support

"This app is not compatible with your Bitbucket instance. Request an update from the vendor." displayed after upgrading to Bitbucket Server 6.0.1

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.