mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
skeptrune
9200586a3a
* docs: boost search ranking for single-word title pages Apply `boost: 3` to English pages whose H1 / frontmatter title is a single word (e.g. "Assistant", "Quickstart", "Cards"). Short titles tend to be canonical landing pages for a topic, so users searching the exact term should land on them first. * docs: drop boost on websocket-playground stub to keep canonical Playground ranking `api-playground/websocket-playground.mdx` is an auto-generated AsyncAPI stub with no body content but shares the title "Playground" with `api-playground/overview.mdx`. Boosting both equally diluted the canonical overview page in search for the query "playground". Drop the boost on the stub.
66 lines
2.7 KiB
Plaintext
66 lines
2.7 KiB
Plaintext
---
|
|
title: "Prompt"
|
|
description: "Display pre-built AI prompts with one-click copy and Cursor integration buttons so users can quickly use prompts in their AI tools."
|
|
keywords: ["prompt", "AI", "cursor", "copy", "prompt card"]
|
|
boost: 3
|
|
---
|
|
|
|
import IconsOptional from "/snippets/icons-optional.mdx";
|
|
|
|
Use the Prompt component to display pre-built AI prompts that users can copy to their clipboard or open directly in [Cursor](https://www.cursor.com).
|
|
|
|
## Examples
|
|
|
|
<Prompt description="Generate clear, concise documentation.">
|
|
You are a **technical writing assistant**. Write documentation that is clear, accurate, and concise.
|
|
- Use second-person voice ("you") and active verbs.
|
|
- Start procedures with a goal-oriented heading.
|
|
- Before writing, ask clarifying questions about the end users of the documentation, their goals, and their needs.
|
|
</Prompt>
|
|
|
|
```mdx Basic prompt example
|
|
<Prompt description="Generate clear, concise documentation.">
|
|
You are a **technical writing assistant**. Write documentation that is clear, accurate, and concise.
|
|
- Use second-person voice ("you") and active verbs.
|
|
- Start procedures with a goal-oriented heading.
|
|
- Before writing, ask clarifying questions about the end users of the documentation, their goals, and their needs.
|
|
</Prompt>
|
|
```
|
|
|
|
<Prompt description="Generate **clear**, *concise* documentation." icon="paperclip" iconType="solid" actions={["copy", "cursor"]}>
|
|
You are a **technical writing assistant**. Write documentation that is clear, accurate, and concise.
|
|
- Use second-person voice ("you") and active verbs.
|
|
- Start procedures with a goal-oriented heading.
|
|
- Before writing, ask clarifying questions about the end users of the documentation, their goals, and their needs.
|
|
</Prompt>
|
|
|
|
```mdx Prompt with multiple properties example
|
|
<Prompt
|
|
description="Generate **clear**, *concise* documentation."
|
|
icon="paperclip"
|
|
iconType="solid"
|
|
actions={["copy", "cursor"]}
|
|
>
|
|
You are a **technical writing assistant**. Write documentation that is clear, accurate, and concise.
|
|
- Use second-person voice ("you") and active verbs.
|
|
- Start procedures with a goal-oriented heading.
|
|
- Before writing, ask clarifying questions about the end users of the documentation, their goals, and their needs.
|
|
</Prompt>
|
|
```
|
|
|
|
## Properties
|
|
|
|
<ResponseField name="description" type="string" required>
|
|
The text displayed in the prompt card. Supports Markdown formatting.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="children" type="string" required>
|
|
The text content of the prompt. This is the text copied to the clipboard or opened in Cursor.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="actions" type="array" default='["copy"]'>
|
|
Array of available actions. Valid values are `"copy"` (copy to clipboard) and `"cursor"` (open in Cursor).
|
|
</ResponseField>
|
|
|
|
<IconsOptional />
|