Skip to content

Support for including images

Images should be stored in the docs/images folder. Use the File Naming Conventions also for naming images.

Syntax

To add an image, apply the following syntax:

![Alt Text](https://anoma.github.io/nspec/main/images/logo.svg){: width="200"}

Displayed Image Example

The syntax above will render the image in your document like so:

Alt Text

Enhanced Image Display

Use an HTML <figure> element with a <figcaption> for a refined presentation with captions. Markdown can also be used within the caption:

<figure markdown="1">
  <img src="docs/images/image-name.png" alt="Alt Text">
  <figcaption markdown="span">Image caption text can include *Markdown*!</figcaption>
</figure>