Skip to content
Merged
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
6 changes: 6 additions & 0 deletions components/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,12 @@
Display additional information on hover.
</Card>

## Showcase AI prompts

<Card title="Prompt" icon="sparkles" href="/components/prompt">
Display copyable AI prompts with Cursor integration.
</Card>

## Show and hide content

<Card title="Accordions" icon="chevron-down" href="/components/accordions">
Expand Down Expand Up @@ -97,7 +103,7 @@
Display content in a grid of clickable tiles.
</Card>

## Add visual context

Check warning on line 106 in components/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/index.mdx#L106

'Add visual context' should use sentence-style capitalization.

<Card title="Icons" icon="smile" href="/components/icons">
Add visual indicators using the Lucide icon library.
Expand Down
64 changes: 64 additions & 0 deletions components/prompt.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
title: "Prompt"
description: "Display pre-built AI prompts with copy and Cursor integration actions."
keywords: ["prompt", "AI", "cursor", "copy", "prompt card"]
---

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 />
1 change: 1 addition & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,7 @@
"components/icons",
"components/mermaid-diagrams",
"components/panel",
"components/prompt",
"components/responses",
"components/steps",
"components/tabs",
Expand Down
18 changes: 13 additions & 5 deletions quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,18 +13,26 @@
When you connect your documentation repository to your project, you can work on your documentation locally or in the web editor and sync any changes to your remote repository.

<Tip>
Using an AI tool to help maintain your documentation?

Run `npx skills add https://mintlify.com/docs` to add the Mintlify [skill](/ai/skillmd).

This skill configures AI coding tools to understand Mintlify project structure, components, and documentation best practices. Add the skill for better results when asking AI tools to update your documentation.
Using an AI coding tool? Copy the prompt below to add the Mintlify [skill](/ai/skillmd) and [MCP server](/ai/model-context-protocol) for better results when updating your documentation.
</Tip>

<Prompt description="Install the Mintlify skill to get context on Mintlify project structure, components, and documentation best practices:

npx skills add https://mintlify.com/docs

Then add the Mintlify MCP server for access to documentation search. Follow the setup instructions at https://www.mintlify.com/docs/ai/model-context-protocol.md" actions={["copy", "cursor"]}>
Install the Mintlify skill to get context on Mintlify project structure, components, and documentation best practices:

npx skills add https://mintlify.com/docs

Then add the Mintlify MCP server for access to documentation search. Follow the setup instructions at https://www.mintlify.com/docs/ai/model-context-protocol.md
</Prompt>

## Deploy your documentation site

Go to [mintlify.com/start](https://mintlify.com/start) and complete the onboarding process. During onboarding, you'll connect your GitHub account, create or select a repository for your documentation, and install the GitHub App to enable automatic deployments.

After onboarding, your documentation site is deployed and accessible at your `.mintlify.app` URL.

Check warning on line 35 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L35

In general, use active voice instead of passive voice ('is deployed').

<AccordionGroup>
<Accordion title="Optional: Skip connecting GitHub during onboarding">
Expand Down Expand Up @@ -64,7 +72,7 @@
<Tab title="CLI">
<Steps>
<Step title="Install the CLI">
The CLI requires [Node.js](https://nodejs.org/en) v20.17.0 or higher. Use an LTS version for stability.

Check warning on line 75 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L75

Spell out 'LTS', if it's unfamiliar to the audience.

<CodeGroup>

Expand Down Expand Up @@ -151,7 +159,7 @@
## Next steps

<Card title="Use the web editor" icon="mouse-pointer-2" horizontal href="/editor/index">
Edit documentation in your browser and preview how your pages will look when published.

Check warning on line 162 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L162

Avoid using 'will'.
</Card>

<Card title="Explore CLI commands" icon="terminal" horizontal href="/installation">
Expand Down
Loading