Images

Embed images in your documentation using markdown syntax.

Images enhance your documentation by providing visual context, diagrams, screenshots, and illustrations. Mordoc supports standard markdown image syntax.

Syntax

Embed images using markdown notation:

Markdown
![Alt Text](image URL)

Alt Text:

Alt text describes the image and is important for accessibility and clarity.

  • Shown if the image cannot be loaded.
  • Read by screen readers for accessibility.
  • Used by search engines to understand the image.

Example

SyntaxResult
Markdown
![Artwork](/images/artwork.png)
Artwork

Image paths

Images should be stored in the public/ directory and referenced using absolute paths, as shown in the example above.

public/
├── images/
    ├── artwork.png
    ├── flux-sail.jpg
    └── diagram.svg

Next steps

  • Lists - Create ordered and unordered lists
  • Tables - Display structured data
  • Code Blocks - Add syntax-highlighted code