diff --git a/components/index.mdx b/components/index.mdx index 559877e63..2362bbdbb 100644 --- a/components/index.mdx +++ b/components/index.mdx @@ -60,6 +60,10 @@ Mintlify provides built-in MDX components for your documentation pages. Use thes Display additional information on hover. + + Mention a teammate or another page inline. + + ## Showcase AI prompts diff --git a/components/mention.mdx b/components/mention.mdx new file mode 100644 index 000000000..7daf15307 --- /dev/null +++ b/components/mention.mdx @@ -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 `` 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 @ in visual mode to insert a mention. + +## Mention a teammate + +```mdx + +``` + +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 @ 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 + +``` + +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 + + + Email address of the organization member to mention. Provide `user` or `page`, not both. + + + + Path of the page to mention, such as `/quickstart`. Provide `user` or `page`, not both. + diff --git a/docs.json b/docs.json index a171c7f3d..2a11ca999 100644 --- a/docs.json +++ b/docs.json @@ -93,6 +93,7 @@ "components/github", "components/icons", "components/mermaid-diagrams", + "components/mention", "components/panel", "components/prompt", "components/responses", diff --git a/editor/agent.mdx b/editor/agent.mdx index a4735a100..518f41c50 100644 --- a/editor/agent.mdx +++ b/editor/agent.mdx @@ -20,7 +20,7 @@ To close the panel, click the **X** button in the panel header or press Cmd Type your request in the chat box at the bottom of the panel and press Enter or click the send button. -Type @ 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 @ 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. @ in agent chat does not open the in-content mention menu. Example prompts: diff --git a/editor/comments.mdx b/editor/comments.mdx index aa104b931..6d17de0e1 100644 --- a/editor/comments.mdx +++ b/editor/comments.mdx @@ -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 @ 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. + + @ in a comment is different from @ 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). + + ## Resolve a comment Editors and admins can resolve threads when a discussion is complete. diff --git a/editor/keyboard-shortcuts.mdx b/editor/keyboard-shortcuts.mdx index f5dcf76f5..d7725e9d5 100644 --- a/editor/keyboard-shortcuts.mdx +++ b/editor/keyboard-shortcuts.mdx @@ -62,6 +62,7 @@ Use these shortcuts when editing in visual mode. | **Toggle suggesting mode** | Cmd + Shift + E | Ctrl + Shift + E | | **Component menu** | / | / | | **Emoji picker** | : + keyword | : + keyword | +| **Mention a teammate or page** | @ | @ | ### Smart substitutions diff --git a/editor/pages.mdx b/editor/pages.mdx index cd40b1fa8..ff4aaa7f1 100644 --- a/editor/pages.mdx +++ b/editor/pages.mdx @@ -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 @@ -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 : followed by a keyword to open the emoji picker. +- **Mention a teammate or page**: Type @ 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 @. +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. + + + In source mode, use the [Mention](/components/mention) component. + + ### 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.