Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions components/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,10 @@ Mintlify provides built-in MDX components for your documentation pages. Use thes
Display additional information on hover.
</Card>

<Card title="Mention" icon="at-sign" href="/components/mention">
Mention a teammate or another page inline.
</Card>

## Showcase AI prompts

<Card title="Prompt" icon="sparkles" href="/components/prompt">
Expand Down
41 changes: 41 additions & 0 deletions components/mention.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
title: "Mention"
description: "Mention a teammate or another page inline with the Mention component."
keywords: ["mention", "mentions", "teammate", "page mention", "user"]
boost: 3
tag: "New"
---

Use `<Mention>` to mention a teammate or another page. Provide exactly one of `user` or `page`.

In the [web editor](/editor/pages#mention-teammates-and-pages), type <kbd>@</kbd> in visual mode to insert a mention.

## Mention a teammate

```mdx
<Mention user="wintergreen@example.com" />
```

The `user` value is the teammate's email address. They must belong to your organization.

On the published site, teammate mentions appear as the person's display name, not their email. Mintlify emails the teammate when you insert the mention from the <kbd>@</kbd> menu in the editor. Saving, pasting, or committing the mention does not send email. Mentioning yourself does not send email.

On a private page, the mentioned teammate must already have access.

## Mention a page

```mdx
<Mention page="/quickstart" />
```

The `page` value is the page href. In the editor, the mention shows the current page title. On the published site, page mentions become regular links.

## Properties

<ResponseField name="user" type="string">
Email address of the organization member to mention. Provide `user` or `page`, not both.
</ResponseField>

<ResponseField name="page" type="string">
Path of the page to mention, such as `/quickstart`. Provide `user` or `page`, not both.
</ResponseField>
1 change: 1 addition & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@
"components/github",
"components/icons",
"components/mermaid-diagrams",
"components/mention",
"components/panel",
"components/prompt",
"components/responses",
Expand Down
2 changes: 1 addition & 1 deletion editor/agent.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ To close the panel, click the **X** button in the panel header or press <kbd>Cmd

Type your request in the chat box at the bottom of the panel and press <kbd>Enter</kbd> or click the <Icon icon="arrow-up" /> send button.

Type <kbd>@</kbd> to mention a specific page. The agent focuses on that page when processing your request. If you don't mention a page, the agent uses the page you currently have open.
Type <kbd>@</kbd> to mention a specific page. The agent focuses on that page when processing your request. If you don't mention a page, the agent uses the page you currently have open. <kbd>@</kbd> in agent chat does not open the in-content mention menu.

Example prompts:

Expand Down
6 changes: 5 additions & 1 deletion editor/comments.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,14 @@ To open a comment thread, click the highlighted text or click the thread in the

## Mention a teammate

Type `@` in a comment or reply to mention a teammate. People must be a member of your organization for you to mention them.
Type <kbd>@</kbd> in a comment or reply to mention a teammate. People must be a member of your organization for you to mention them.

Mentioned teammates receive an email notification.

<Note>
<kbd>@</kbd> in a comment is different from <kbd>@</kbd> in the page body, which inserts an in-content mention of a teammate or page. See [Mention teammates and pages](/editor/pages#mention-teammates-and-pages).
</Note>

## Resolve a comment

Editors and admins can resolve threads when a discussion is complete.
Expand Down
1 change: 1 addition & 0 deletions editor/keyboard-shortcuts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ Use these shortcuts when editing in visual mode.
| **Toggle suggesting mode** | <kbd>Cmd</kbd> + <kbd>Shift</kbd> + <kbd>E</kbd> | <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>E</kbd> |
| **Component menu** | <kbd>/</kbd> | <kbd>/</kbd> |
| **Emoji picker** | <kbd>:</kbd> + keyword | <kbd>:</kbd> + keyword |
| **Mention a teammate or page** | <kbd>@</kbd> | <kbd>@</kbd> |

### Smart substitutions

Expand Down
27 changes: 25 additions & 2 deletions editor/pages.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Create and edit pages"
description: "Create pages, edit content, upload images and video, and manage files in the Mintlify web editor with rich-text editing and search across your content."
keywords: ["editor", "content", "pages", "files", "create", "edit", "version history", "media", "images", "video", "task lists", "private pages"]
description: "Create pages, edit content, mention teammates, upload images and video, and manage files in the Mintlify web editor with rich-text editing and search across your content."
keywords: ["editor", "content", "pages", "files", "create", "edit", "version history", "media", "images", "video", "task lists", "private pages", "mentions"]
---

## Navigate files
Expand Down Expand Up @@ -48,12 +48,35 @@ Switch between visual and source mode using the mode toggle in the toolbar below
- **Link to another page**: Right-click a page in the navigation tree, click **Copy link**, then paste the link into your content. The editor recognizes internal links to other pages and converts them.
- **Insert media from your project**: Drag an image or video from the navigation tree into the page to embed it inline. Supported formats include PNG, JPG, JPEG, GIF, WebP, SVG, MP4, and WebM.
- **Insert an emoji**: Type <kbd>:</kbd> followed by a keyword to open the emoji picker.
- **Mention a teammate or page**: Type <kbd>@</kbd> to open the mention menu.
- **Edit a table**: When your cursor is inside a table, use the floating toolbar to add or remove rows and columns, or merge cells.

**Source mode** gives you direct access to the MDX source. Use it for precise control over component properties and frontmatter.

For a full list of components, see [Components](/components). For MDX syntax, see [Format text](/create/text) and [Format code](/create/code).

### Mention teammates and pages

In visual mode, mention a teammate or another page:

1. Place your cursor in the page.
1. Type <kbd>@</kbd>.
1. Select a teammate or a page.

The menu inserts one mention at a time: a person or a page.

**Teammates** must belong to your organization. Mintlify emails them when you select them from the menu. Saving, pasting, or committing the mention does not send email. Mentioning yourself does not send email.

On the published site, teammate mentions appear as the person's display name, not their email.

**Pages** show the current page title in the editor. On the published site, page mentions become regular links.

On a private page, the mentioned teammate must already have access.

<Note>
In source mode, use the [Mention](/components/mention) component.
</Note>

### Task lists

In visual mode, type `/task` and select **Task List** to add an interactive checklist. You can also type `- [ ]` followed by a space to turn a list item into a task. Click the checkbox beside a task to mark it complete.
Expand Down