|
1 | 1 | --- |
2 | 2 | title: "AI Ingestion" |
3 | | -description: "How to feed your docs into LLMs" |
| 3 | +description: "Learn how to feed your documentation into LLMs and AI tools" |
4 | 4 | icon: "bot-message-square" |
5 | 5 | --- |
6 | 6 |
|
7 | | -All documentation pages are auto-hosted in a variety of markdown formats to make it easier for: |
| 7 | +export const PreviewButton = ({ children, href }) => { |
| 8 | + return ( |
| 9 | + <a href={href} className="text-sm font-medium text-white dark:!text-zinc-950 bg-zinc-900 hover:bg-zinc-700 dark:bg-zinc-100 hover:dark:bg-zinc-300 rounded-full px-3.5 py-1.5 not-prose"> |
| 10 | + {children} |
| 11 | + </a> |
| 12 | + ) |
| 13 | +} |
8 | 14 |
|
9 | | -- End users to feed your docs into large language models (LLMs) for specific information retrieval |
10 | | -- LLMs to efficiently index your content without parsing HTML or JavaScript |
| 15 | +Documentation pages are content rich and can be a great source of information for LLMs for AI tools. |
11 | 16 |
|
12 | | -## Supported formats |
| 17 | +Today, you can use your documentation to fine-tune a chatbot, answer questions about your product, or use it to generate code. |
13 | 18 |
|
14 | | -We support industry standards such as [/llms.txt](https://llmstxt.org) as well as additional markdown formats. |
| 19 | +## Supported Shortcuts |
15 | 20 |
|
16 | | -- **/llms.txt**: A markdown file of a structured index of your docs is automatically hosted at /llms.txt. Helps general-purpose LLMs index more efficiently (e.g. a sitemap for AI). |
17 | | -- **/llms-full.txt**: A markdown file of all your docs content is automatically hosted at /llms-full.txt. Helps users load complete context into AI tools in one link. |
18 | | -- **.md support**: Add .md to an individual docs page to see a markdown version of that page. Helps load individual pages into AI tools with better token efficiency & inference time. |
19 | | -- **⌘ \+ c shortcut**: Copy markdown source of any page using command \+ c. |
| 21 | +We support a variety of shortcuts to make it easier to use your documentation in AI tools. |
| 22 | + |
| 23 | +### llms.txt |
| 24 | + |
| 25 | +A markdown file of a structured index of your docs is automatically hosted at [/llms.txt](https://llmstxt.org). |
| 26 | + |
| 27 | +llms.txt is an industry standard that helps general-purpose LLMs index more efficiently (e.g. a sitemap for AI). |
| 28 | + |
| 29 | +<PreviewButton href="/llms.txt">Open llms.txt preview</PreviewButton> |
| 30 | + |
| 31 | +### llms-full.txt |
| 32 | + |
| 33 | +A markdown file of all your docs content is automatically hosted at **/llms-full.txt**. |
| 34 | + |
| 35 | +llms-full.txt contains the entire content of your docs, and is a great way to provide a complete context to AI tools. |
| 36 | + |
| 37 | +<PreviewButton href="/llms-full.txt">Open llms-full.txt preview</PreviewButton> |
| 38 | + |
| 39 | +### .md support |
| 40 | + |
| 41 | +Add .md to an individual docs page to see a markdown version of that page. Helps load individual pages into AI tools with better token efficiency & inference time. |
| 42 | + |
| 43 | +<PreviewButton href="/docs/quickstart.md">Open quickstart.md preview</PreviewButton> |
| 44 | + |
| 45 | +### Contextual menu |
| 46 | + |
| 47 | +You can enable a [contextual menu](/core-concepts/settings#param-contextual) to allow users to copy markdown source, view markdown source, or open ChatGPT with the page content. |
| 48 | + |
| 49 | +### ⌘ \+ c shortcut |
| 50 | + |
| 51 | +Copy markdown source of any page using command \+ c. |
0 commit comments