Skip to content

New Accordion #884

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed
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
28 changes: 15 additions & 13 deletions ai-ingestion.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "AI ingestion"
description: "Prepare your documentation for LLMs and AI tools"

Check warning on line 3 in ai-ingestion.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

ai-ingestion.mdx#L3

Did you really mean 'LLMs'?
icon: "bot-message-square"
---

Expand All @@ -12,22 +12,24 @@
)
}

Mintlify generates optimized formats and provides shortcuts that help users get faster, more accurate responses when using your documentation as context for LLMs and AI tools.

Check warning on line 15 in ai-ingestion.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

ai-ingestion.mdx#L15

Did you really mean 'LLMs'?

<Accordion title="New Accordion" icon="sparkles">
Accordion
</Accordion>


## Contextual menu

Provide quick access to AI-optimized content and direct integrations with popular AI tools from a contextual menu on your pages.

* **Copy page**: Copies the current page as Markdown for pasting as context into AI tools.
* **View as Markdown**: Opens the current page as Markdown.
* **Open in ChatGPT**: Creates a ChatGPT conversation with the current page as context.
* **Open in Claude**: Creates a Claude conversation with the current page as context.
- **Copy page**: Copies the current page as Markdown for pasting as context into AI tools.
- **View as Markdown**: Opens the current page as Markdown.
- **Open in ChatGPT**: Creates a ChatGPT conversation with the current page as context.
- **Open in Claude**: Creates a Claude conversation with the current page as context.

<Frame>
<img
src="/images/contextual-menu/contextual-menu.png"
alt="The expanded contextual menu showing the Copy page, View as Markdown, Open in ChatGPT, and Open in Claude menu items."
/>
![The expanded contextual menu showing the Copy page, View as Markdown, Open in ChatGPT, and Open in Claude menu items.](/images/contextual-menu/contextual-menu.png)
</Frame>

### Enabling the contextual menu
Expand All @@ -40,8 +42,8 @@
"options": [
"copy",
"view",
"chatgpt",

Check warning on line 45 in ai-ingestion.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

ai-ingestion.mdx#L45

Did you really mean 'chatgpt'?
"claude"

Check warning on line 46 in ai-ingestion.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

ai-ingestion.mdx#L46

Did you really mean 'claude'?
]
}
}
Expand All @@ -49,30 +51,30 @@

## /llms.txt

The [/llms.txt file](https://llmstxt.org) is an industry standard that helps general-purpose LLMs index more efficiently, similar to how a sitemap helps search engines.

Check warning on line 54 in ai-ingestion.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

ai-ingestion.mdx#L54

Did you really mean 'LLMs'?

Every documentation site automatically hosts an `/llms.txt` file at the root that lists all available pages in your documentation. AI tools can use this file to understand your documentation structure and find relevant content to user prompts.

<PreviewButton href="https://mintlify.com/docs/llms.txt">Open llms.txt for this site</PreviewButton>
Open llms.txt for this site

## /llms-full.txt

The `/llms-full.txt` file combines your entire documentation site into a single file as context for AI tools.

Every documentation site automatically hosts an `/llms-full.txt` file at the root.

<PreviewButton href="https://mintlify.com/docs/llms-full.txt">Open llms-full.txt for this site</PreviewButton>
Open llms-full.txt for this site

## Generating Markdown versions of pages

Markdown provides structured text that AI tools can process more efficiently than HTML, which results in better response times and lower token usage.

### .md extension

Add a `.md` to a page's URL to display a Markdown version of that page.
Add a `.md` to a page's URL to display a Markdown version of that page.

<PreviewButton href="https://mintlify.com/docs/quickstart.md">Open quickstart.md</PreviewButton>
Open quickstart.md

### Command \+ C shortcut

Select Command \+ C (Ctrl \+ C on Windows) to copy any page as Markdown.
Select Command \+ C (Ctrl \+ C on Windows) to copy any page as Markdown.

Check warning on line 80 in ai-ingestion.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

ai-ingestion.mdx#L80

Did you really mean 'Ctrl'?