> For the complete documentation index, see [llms.txt](https://docs.nimbalyst.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.nimbalyst.com/visual-editors-powered-by-ai/mermaid-diagrams-and-images.md).

# Mermaid Diagrams and Images

Insert and edit Mermaid diagrams and images inside Nimbalyst markdown documents, by hand or by asking your AI agent to generate the syntax.

Markdown documents in Nimbalyst can hold rendered Mermaid diagrams and images alongside your text, so a spec or plan carries its own visuals. You can insert either by hand or by asking your agent.

### Mermaid Diagrams

<figure><img src="https://562749618-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiVUeHZHlFlZrZt02syRC%2Fuploads%2Fgit-blob-077d6b07217d3dc18ffa9adb7c79d0a564da6887%2FMermaid%20in%20Nimbalyst%20(1).gif?alt=media" alt=""><figcaption><p>A markdown document open beside the agent panel, where the agent's edit to the document is applied and reviewed.</p></figcaption></figure>

**Manually**: type **/** in WYSIWYG view and insert a Mermaid Diagram, then click **Edit** on the diagram block to edit the Mermaid syntax.

**With AI**: ask the agent to create a Mermaid diagram in the document, then edit it manually or keep iterating on it in chat.

Diagram types include:

* Flowchart
* Sequence diagram
* Gantt chart
* Class diagram
* State diagram
* Entity relationship

See the [diagrams feature page](https://nimbalyst.com/features/diagrams/) for how teams use Mermaid and Excalidraw together, and [architecture diagrams](https://nimbalyst.com/use-cases/architecture-diagrams/) for a worked example.

### Images

<div align="left"><figure><img src="https://562749618-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiVUeHZHlFlZrZt02syRC%2Fuploads%2FnXMLAZkpN6LfCCPy25VW%2FImages.png?alt=media&amp;token=ccb13634-d660-4753-8d9c-cc2a5bd9a624" alt="" width="375"><figcaption><p>A document in dark mode with an embedded architecture image rendered under an Images heading, above a feature table.</p></figcaption></figure></div>

Paste or insert an image into a document and resize it in place. Nimbalyst stores the image in an assets folder next to the markdown file and writes a normal markdown link to it, so the document stays portable.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.nimbalyst.com/visual-editors-powered-by-ai/mermaid-diagrams-and-images.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
