> 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) Nimbalyst is a WYSIWYG AI markdown editor. Write visually while plain .md files stay on disk, with agent editing built into the same document. The Markdown editor is Nimbalyst's main writing surface. You see formatted text as you type, while the file on disk stays a plain `.md` file that Git, other tools, and your AI agent can all read. Use it for docs, specs, plans, notes, and anything else you write in markdown.

A workspace with the file tree on the left, the document area in the center, and the agent panel with suggested slash commands on the right.

### Why Nimbalyst as a Markdown Editor? * **True markdown files** on disk, edited visually * **Unified content**: text, tables, code, lists, images, and embedded visual editors in one document * **AI-integrated**: agents see your documents and can research, write, edit, and code alongside you * **Fast, minimal interface** built for distraction-free writing The [markdown editor feature page](https://nimbalyst.com/features/markdown-editor/) has a fuller walkthrough of WYSIWYG editing with agents. ### Important Commands * **@** references a file in the document or in chat. Supported custom-editor files (mockups, Excalidraw, data models, CSV, and others) embed as live frames when the link is on its own line; see "Embedding Custom-Editor Files" below. * **/** opens the menu of insertion options: tables, Mermaid diagrams, tracker items, and more. * **#** creates a tagged tracker item (bug, task, plan, idea) inline. * Selecting text shows a **toolbar** with quick formatting options. * Standard **markdown syntax** works as you type.

An annotated overview: the file tree on the left, a document with a red/green AI diff and its review bar in the center, and the agent chat on the right.

### File and Editor View Open any markdown file from the file tree and edit it as a formatted document.

A markdown plan document open in WYSIWYG view, with the workspace file tree on the left and other documents in tabs.

### WYSIWYG and Raw Markdown Toggle between the formatted view and raw markdown using the three-dot menu at the top right of the document.

The three-dot menu with Toggle Markdown Mode, View History, and Copy as Markdown.

### Text Common markdown shortcuts: * **Headings:** `#` plus a space for H1, `##` plus a space for H2 * **Lists:** `-` or `*` plus a space; Tab to indent * **Numbered lists:** `1` plus a space * **Links:** select text and click the link icon in the toolbar * **Quotes:** `>` plus a space; nest with `>>` * **Code blocks:** type `/` and insert * **Horizontal rule:** type `---` * Inline formatting like `**bold**` and `*italic*` works as you type ### Tables ![](https://562749618-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiVUeHZHlFlZrZt02syRC%2Fuploads%2FlLnecLXnnlGvdRL3AUBO%2FTables.png?alt=media\&token=ebf7c164-00e6-47b0-b645-056805b2859e) Create a table by typing **/** and choosing Table.

The slash menu, with plugin items such as Mermaid Diagram and tracker items, and the Tables section below.

Format a table by clicking the down arrow on a cell.

The table menu with options to insert or delete columns and rows, delete the table, and remove the row header.

### 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`, `.prisma`, `.csv`, or any other custom-editor file on its own line and Nimbalyst upgrades it into an embedded editor in WYSIWYG view.

A markdown spec with a mockup and an Excalidraw diagram embedded inline below their @-references — A markdown spec with a mockup and an Excalidraw diagram embedded inline.

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-dot menu 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)` 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 and Redo * **Cmd+Z** to undo * **Cmd+Shift+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=&goal= ``` `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.