Prompt - Mintlify

Documentation Index

Fetch the complete documentation index at: /docs/llms.txt

Use this file to discover all available pages before exploring further.

Use the Prompt component to display pre-built AI prompts that users can copy to their clipboard or open directly in Cursor.

Examples

Generate clear, concise documentation.

CopiedCopy prompt

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>

Generate clear, concise documentation.

CopiedCopy prompt CursorOpen in Cursor

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

description

string

required

The text displayed in the prompt card. Supports Markdown formatting.

children

string

required

The text content of the prompt. This is the text copied to the clipboard or opened in Cursor.

actions

array

default:"["copy"]"

Array of available actions. Valid values are "copy" (copy to clipboard) and "cursor" (open in Cursor).

icon

string

The icon to display. Options:

• Font Awesome icon name.
• Lucide icon name.
• Tabler icon name.
• A single emoji (e.g., 💡 or 🚀).
• URL to an externally hosted icon.
• Path to an icon file in your project.
• SVG code wrapped in curly braces.

For custom SVG icons:

1. Convert your SVG using the SVGR converter.
2. Paste your SVG code into the SVG input field.
3. Copy the complete <svg>...</svg> element from the JSX output field.
4. Wrap the JSX-compatible SVG code in curly braces: icon={<svg ...> ... </svg>}.
5. Adjust height and width as needed.

iconType

string

The Font Awesome icon style. Only used with Font Awesome icons. Options: regular, solid, light, thin, sharp-solid, duotone, brands.

className

string

Additional CSS classes to apply to the prompt card.