Using an Image as a Link in AsciiDoc

Question

I'm trying to create a "clickable" image in AsciiDoc lightweight markup language with Asciidoctor.

I tried the following (not working): image::<url1>[<url2>[]]

For example:

image::https://img.shields.io/badge/License-Apache%202.0-blue.svg[http://www.apache.org/licenses/LICENSE-2.0[]]

It should become roughly the following html:

<a href="http://www.apache.org/licenses/LICENSE-2.0"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"></a>

How can I accomplish this in AsciiDoc without passing through raw HTML?

score 34 · Accepted Answer · answered Dec 16 '15 at 17:01

34

block:

image::https://img.shields.io/badge/License-Apache%202.0-blue.svg[link="http://www.apache.org/licenses/LICENSE-2.0"]

inline:

image:https://img.shields.io/badge/License-Apache%202.0-blue.svg[link="http://www.apache.org/licenses/LICENSE-2.0"]

Notice the link attribute on the image.

answered Dec 16 '15 at 17:01

LightGuard

This also works for relative links as well `image:static/researchtab.png[link="static/researchtab.png"]` – Senthilkumar Gopal May 09 '19 at 15:24
1

And it's a good idea to include an alt attribute for images `image:foo.jpg[link="bar.html" alt="Picture of a Foo"]`. – DaveGauer Oct 01 '21 at 17:56
1

@DaveGauer, this can also be rewritten as `image:foo.jpg[Picture of a Foo,link="bar.html"]` – Bass Aug 26 '22 at 16:27

1 Answers1