Skip to content

Commit 08ce1cd

Browse files
authored
docs: add information on image links
1 parent f583a3f commit 08ce1cd

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.asciidoc

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1718,6 +1718,24 @@ Which looks like:
17181718

17191719
image::resources/readme/example.svg[An example svg]
17201720

1721+
[[image-links]]
1722+
=== Image links
1723+
1724+
You can add relative or absoloute links to your images with the following syntax:
1725+
1726+
[source,asciidoc]
1727+
----
1728+
image:./images/dynamic-config.svg[link=configuration.html#configuration-dynamic]
1729+
----
1730+
1731+
Using internal link attributes is also supported, but the image must be inside the internal link syntax.
1732+
It's important to add a space on each side of the image tag. Without spaces, the image will not render.
1733+
1734+
[source,asciidoc]
1735+
----
1736+
<<configuration-dynamic, image:./images/dynamic-config.svg[] >>
1737+
----
1738+
17211739
[[videos]]
17221740
== Videos
17231741

0 commit comments

Comments
 (0)