Markdown

You can write in DocStar with Markdown. Type a shortcut at the start of a line and the editor turns it into the matching block, or paste Markdown from another tool and it arrives fully formatted.

#

Shortcuts while you type

Type these at the start of an empty line, followed by a space (except where noted).

Type You get
# Heading (add more # for a smaller heading)
-, * or + Bullet list
1. Numbered list
[ ] Check list item ([x] for a checked one)
> Quote
``` Code block (you can add a language, for example ```python)
--- (no space needed) Divider

Anything you can't type as a shortcut is in the slash menu. Type / and search, for example /table or /alert. See Editor Basics.

#

Paste Markdown

Copy Markdown from a file, README or AI assistant and paste it into a page. DocStar converts it into blocks: headings, lists, tables, links, images and code blocks keep their formatting. When the clipboard holds rich formatted content (for example from a web page or a word processor), DocStar keeps that formatting instead.

To bring in whole Markdown or MDX files, use Import Pages in the collection's Settings. See Import Content.

#

Markdown examples

Text formatting

**Bold text**, *italic text*, ~~strikethrough~~ and `inline code`.
[Visit our website](https://example.com)

Lists

- Easy document creation
- Real-time collaboration
- Built-in API testing

1. Sign up for DocStar
2. Create a collection
3. Add your first page

- [x] Write the draft
- [ ] Review with the team

Quote

> Documentation is not just about writing; it's about conveying ideas clearly.

Image

![Dashboard overview](https://example.com/images/dashboard.png)

Table

| Plan | Pages | Custom domain |
| --- | --- | --- |
| Free | 50 | No |
| Pro | Unlimited | Yes |

Code block

```python
def greet():
    print("Welcome to DocStar!")
```

Divider

---
#

DocStar blocks in Markdown

Some DocStar blocks have no standard Markdown form. When a page is stored or exported as Markdown, they are written as tags:

Block Markdown form
Alert <alert type="info">Back up your data first.</alert> (type can be info, success, warning or error)
Link to Page <card href="PAGE_ID">Page title</card>

You'll see these tags when you read pages through the API, the CLI or an AI assistant connected over MCP. Keep them intact when you edit Markdown outside DocStar so the blocks come back correctly. See AI Assistant Tools.

#

Tips

  • The page title is the page's only top-level heading. A # heading becomes Heading 1 inside the page body.
  • Use headings in order (Heading 1, then Heading 2) to build a clear table of contents and help search engines. See SEO.
Built with DocStar