> 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/markdown-wysiwyg.md).

# Markdown (WYSIWYG)

<figure><img src="/files/3AcX6sq9rIZlUGneEgL3" alt=""><figcaption></figcaption></figure>

### Why Nimbalyst as a Markdown Editor?

* **Fast** - Blazing performance for distraction-free writing
* **Clean UI** - Minimal interface focused on your content
* **Focused** - Dedicated to markdown writing and editing
* **Native Markdown** - True markdown support without compromises
* **WYSIWYG** - See formatted output as you type
* **Delightful** - Smooth, intuitive user experience
* **Unified Content** - Work seamlessly with text, tables, code, lists, and images.
* **AI-Integrated -** Leverage AI and Agents that see your documents to research, write, edit, code

### Important Commands

* **Reference a file in another document or in chat:** @ — supported custom-editor files (mockups, Excalidraw, data models, CSV, etc.) embed as live frames when the link is on its own line. See "Embedding Custom-Editor Files" below.
* **Open the mega-menu of insertion options:** /
* **Create a tagged bug, idea, plan:** #
* **Text selection toolbar** appears when you select text, providing quick formatting options.
* **Markdown formatting and commands are supported**

<figure><img src="/files/0PzRCHU1Zdqo1ZwmaC0w" alt=""><figcaption></figcaption></figure>

### File and Editor View

Work with your markdown files, edit the documents in WYSIWIG

<figure><img src="/files/HKc2LYDUY6t1Zti7MlBQ" alt=""><figcaption></figcaption></figure>

### WYSIWIG Markdown

Toggle between Markdown and WYSIWIG using the 3 dots at the upper right of the document

<div align="left"><figure><img src="/files/FI3CtFJrh6g2QgYAWmmr" alt="" width="227"><figcaption></figcaption></figure></div>

### Text

Some basic markdown commands

* **Headings:** # followed by space for H1, ## followed by space for H2
* **Lists:** - or \* followed by space, Tab to indent
* **Numbered Lists:** 1 followed by space
* **Links:** Select text and select link icon in toolbar
* **Quotes:** Type > followed by space. Nest by typing >>
* **Code Blocks:** Type / and insert
* **Horizontal Rule:** Type ---
* **Markdown Text Formatting:** Supported

### Tables

![](/files/j3UPp2QcjiArxVozXV9B)

**Create a table by typing /**

<div align="left"><figure><img src="/files/tTheQcCOGyLU03G7In7z" alt="" width="286"><figcaption></figcaption></figure></div>

Format Table by clicking on down arrow

<div align="left"><figure><img src="/files/zczxMSQ6wdhssXdoVZkI" alt="" width="259"><figcaption></figcaption></figure></div>

### Embedding Custom-Editor Files

A markdown document can render other workspace files inline as live frames. Drop a link to a file like `.mockup.html`, `.excalidraw`, `.datamodel`, `.csv`, or any other custom-editor file on its own line and Nimbalyst upgrades it into an embedded editor in WYSIWYG view.

<figure><img src="/files/MCi0dxFgWGTBJaV9WNAs" alt="A markdown spec with a mockup and an Excalidraw diagram embedded inline below their @-references"><figcaption><p>A markdown spec with a mockup and an Excalidraw diagram embedded inline.</p></figcaption></figure>

How it works:

* Type `@` to pick a file. If the file is a supported custom-editor type and the link ends up alone in its own paragraph, it auto-upgrades to an inline embed.
* You can also paste a normal markdown link like `[my mockup](./docs/api.mockup.html)` on its own line.
* The embedded frame is the real editor for that file. Edit it in place and the change saves back to the file on disk.
* Multiple users see embedded edits stream in live when the document is shared.

Switch to raw Markdown view (the three dots at the top right) to see the underlying link. The link round-trips: write a link in raw view, switch to WYSIWYG, and it becomes a live frame.

### AI Editing in Shared Collaborative Documents

When you are editing a shared document in collaboration mode, the right-pane chat sees and edits the active document the same way it does in Files mode. Edits route through Yjs, so other connected users see them stream in live. The familiar accept/reject bar appears for pending AI edits, just like in single-user editing.

You don't need to do anything special to turn this on — open a shared document, ask the agent to edit it, and the changes flow into the document for everyone in the session.

### Anchor Links to Headings

Clicking a Markdown anchor link like `[Section](#section)` in a Lexical document scrolls the document to the matching heading.

### Export to PDF

Markdown documents export to PDF with the document title and an outline generated from your headings. Exported files are bookmarked at each heading and the title shows up in PDF readers.

### Undo/Redo Stack

Nimbalyst enables you to undo and redo your edits

* Cmd+Z to Undo
* Cmd+Option+Z to Redo


---

# 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/markdown-wysiwyg.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.
