Initial commit

This commit is contained in:
Kenan Zhu authored and GitHub committed 2026-05-21 21:23:13 +08:00
commit 04174b399f
35 files changed
+2020

No files matched your search

+133
View File
@@ -0,0 +1,133 @@
---
title: "Introduction"
description: "Welcome to the new home for your documentation"
icon: 'star'
---
## Setting up
Get your documentation site up and running in minutes.
<Card
title="Start here"
icon="rocket"
href="/quickstart"
horizontal
>
Follow our three step quickstart guide.
</Card>
## Make it yours
Design a docs site that looks great and empowers your users.
<Columns cols={2}>
<Card
title="Edit locally"
icon="pen-to-square"
href="/development"
>
Edit your docs locally and preview them in real time.
</Card>
<Card
title="Customize your site"
icon="palette"
href="/essentials/settings"
>
Customize the design and colors of your site to match your brand.
</Card>
<Card
title="Set up navigation"
icon="map"
href="/essentials/navigation"
>
Organize your docs to help users find what they need and succeed with your product.
</Card>
<Card
title="API documentation"
icon="terminal"
href="/api-reference/introduction"
>
Auto-generate API documentation from OpenAPI specifications.
</Card>
</Columns>
## Create beautiful pages
Everything you need to create world-class documentation.
<Columns cols={2}>
<Card
title="Write with MDX"
icon="pen-fancy"
href="/essentials/markdown"
>
Use MDX to style your docs pages.
</Card>
<Card
title="Code samples"
icon="code"
href="/essentials/code"
>
Add sample code to demonstrate how to use your product.
</Card>
<Card
title="Images"
icon="image"
href="/essentials/images"
>
Display images and other media.
</Card>
<Card
title="Reusable snippets"
icon="recycle"
href="/essentials/reusable-snippets"
>
Write once and reuse across your docs.
</Card>
</Columns>
## Make your content agent ready
Make your docs work for humans and AI agents alike.
<Columns cols={2}>
<Card
title="Prompt component"
icon="robot"
href="/agent-ready/prompt"
>
Embed shareable AI prompts readers can copy or open in Cursor.
</Card>
<Card
title="Visibility"
icon="eye"
href="/agent-ready/visibility"
>
Show different content to humans and agents reading your docs.
</Card>
<Card
title="Contextual menu"
icon="bolt"
href="/agent-ready/contextual"
>
Give readers one-click access to Claude, ChatGPT, Cursor, and more.
</Card>
<Card
title="AI coding tools"
icon="wand-magic-sparkles"
href="/ai-tools/claude-code"
>
Set up Claude Code, Cursor, or Windsurf with Mintlify's skill.
</Card>
</Columns>
## Need inspiration?
<Card
title="See complete examples"
icon="stars"
href="https://mintlify.com/customers"
>
Browse our showcase of exceptional documentation sites.
</Card>