Skip to content

Commit

Permalink
feat: clean up figures documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ronaldtse committed Mar 31, 2024
1 parent eae5bd7 commit f9752af
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions author/topics/blocks/figures.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ A single block image in isolation is treated as a figure.
[source,asciidoc]
--
.Figure title
image::figure-path.png[]
image::{PATH}.png[]
--
====

Expand All @@ -52,7 +52,7 @@ image::figure-path.png[]
A figure block can contain multiple types and instances of content, such as
images, paragraphs and admonitions.

A figure block requires explicitly declaring an example block with the
A figure block is encoded as an example block with the
`[figure]` role [added in https://github.com/metanorma/metanorma-standoc/releases/tag/v2.0.7].

.Explicit figure declaration
Expand All @@ -62,11 +62,11 @@ A figure block requires explicitly declaring an example block with the
[figure]
.Figure title
====
image::figure-path.png[alt text]
image::{PATH}.png[alt text]

This is some random explanatory text
This is explanatory text.

NOTE: And this is a note
NOTE: And this is a note.
====
--
=====
Expand All @@ -75,6 +75,7 @@ NOTE: Previously the explicit declaration on the example block uses the
`[.figure]` role.



=== Key

Figures can be followed by a definition list for the variables
Expand Down

0 comments on commit f9752af

Please sign in to comment.