Image Block
Display images with optional captions. Support for screenshots, diagrams, photos, and any visual content in your architecture documentation.
Image blocks display visual content in your documentation. Use them for screenshots, photos, external diagrams, or any image that helps explain your architecture.
When to Use
Block Properties
| Property | Required | Description |
|---|---|---|
| Image URL | Yes | Path to the image file (relative or absolute URL) |
| Alt Text | No | Accessibility description for screen readers |
| Caption | No | Optional caption displayed below the image |
Best Practices
| Practice | Description |
|---|---|
| Alt Text | Always provide meaningful alt text for accessibility |
| Captions | Use captions to explain what the image shows and why it matters |
| File Size | Optimise images for web to improve page load times |
| Resolution | Use high enough resolution for clarity, but not excessive |
| Format | Use PNG for screenshots, JPEG for photos, SVG for vector graphics |
Image vs Diagram Blocks
| Feature | Image Block | Diagram Block |
|---|---|---|
| Source | External images | Created in NeoArc |
| Interactive | Static display | Pan, zoom, navigation |
| Version Control | Image file only | Full diagram source |
| Theme Support | Manual matching | Automatic theme matching |
| Updates | Re-export required | Edit and save directly |