Skip to content

Commit b603f44

Browse files
authored
Documentation edits made through Mintlify web editor
1 parent 3a37747 commit b603f44

File tree

2 files changed

+20
-27
lines changed

2 files changed

+20
-27
lines changed

ai-ingestion.mdx

Lines changed: 14 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -14,22 +14,17 @@ export const PreviewButton = ({ children, href }) => {
1414

1515
Generate optimized formats and provide shortcuts that help users get faster, more accurate responses when using your documentation as context for LLMs and AI tools.
1616

17-
## Contextual menu
18-
1917
Provide quick access to AI-optimized content and direct integrations with popular AI tools from a contextual menu on your pages.
2018

21-
* **Copy page**: Copies the current page as Markdown for pasting as context into AI tools.
22-
* **View as Markdown**: Opens the current page as Markdown.
23-
* **Open in ChatGPT**: Creates a ChatGPT conversation with the current page as context.
24-
* **Open in Claude**: Creates a Claude conversation with the current page as context.
25-
* **Ask Perplexity**: Creates a Perplexity conversation with the current page as context.
26-
* [**Your custom options**](#adding-custom-options): Add your own options to the contextual menu.
19+
- **Copy page**: Copies the current page as Markdown for pasting as context into AI tools.
20+
- **View as Markdown**: Opens the current page as Markdown.
21+
- **Open in ChatGPT**: Creates a ChatGPT conversation with the current page as context.
22+
- **Open in Claude**: Creates a Claude conversation with the current page as context.
23+
- **Ask Perplexity**: Creates a Perplexity conversation with the current page as context.
24+
- [**Your custom options**](#adding-custom-options): Add your own options to the contextual menu.
2725

2826
<Frame>
29-
<img
30-
src="/images/contextual-menu/contextual-menu.png"
31-
alt="The expanded contextual menu showing the Copy page, View as Markdown, Open in ChatGPT, and Open in Claude menu items."
32-
/>
27+
![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)
3328
</Frame>
3429

3530
### Enabling the contextual menu
@@ -68,20 +63,18 @@ Create custom options in the contextual menu by adding an object to the `options
6863

6964
<ResponseField name="href" type="string | object" required>
7065
The href of the option. Use a string for simple links or an object for dynamic links with query parameters.
71-
66+
7267
<Expandable title="href object">
7368
<ResponseField name="base" type="string" required>
7469
The base URL for the option.
7570
</ResponseField>
76-
7771
<ResponseField name="query" type="object" required>
7872
The query parameters for the option.
7973

8074
<Expandable title="query object">
8175
<ResponseField name="key" type="string" required>
8276
The query parameter key.
8377
</ResponseField>
84-
8578
<ResponseField name="value" type="string" required>
8679
The query parameter value. Use `$page` to insert the current page content in Markdown or `$path` to insert the current page path.
8780
</ResponseField>
@@ -92,7 +85,7 @@ Create custom options in the contextual menu by adding an object to the `options
9285

9386
Example custom option:
9487

95-
```json {7-20} Example with Perplexity icon="search"
88+
```json Example with Perplexity {7,8,9,10,11,12,13,14,15,16,17,18,19,20} icon=search
9689
"contextual": {
9790
"options": [
9891
"copy",
@@ -123,26 +116,26 @@ The [/llms.txt file](https://llmstxt.org) is an industry standard that helps gen
123116

124117
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.
125118

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

128121
## /llms-full.txt
129122

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

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

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

136129
## Generating Markdown versions of pages
137130

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

140133
### .md extension
141134

142-
Add a `.md` to a page's URL to display a Markdown version of that page.
135+
Add a `.md` to a page's URL to display a Markdown version of that page.
143136

144-
<PreviewButton href="https://mintlify.com/docs/quickstart.md">Open quickstart.md</PreviewButton>
137+
Open quickstart.md
145138

146139
### Command \+ C shortcut
147140

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

code.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ icon: "code"
88

99
You can add inline code snippets or code blocks. Code blocks support meta options for syntax highlighting, titles, line highlighting, icons, and more.
1010

11-
### Inline code
11+
### Hello world
1212

1313
To denote a `word` or `phrase` as code, enclose it in backticks (\`).
1414

@@ -22,7 +22,7 @@ Use [fenced code blocks](https://www.markdownguide.org/extended-syntax/#fenced-c
2222

2323
Specify the programming language for syntax highlighting and to enable meta options. Add any meta options, like a title or icon, after the language.
2424

25-
```java HelloWorld.java lines icon="java"
25+
```java HelloWorld.java icon=java lines
2626
class HelloWorld {
2727
public static void main(String[] args) {
2828
System.out.println("Hello, World!");
@@ -95,7 +95,7 @@ const hello = "world";
9595

9696
Add an icon to your code block. You can use [FontAwesome](https://fontawesome.com/icons) icons, [Lucide](https://lucide.dev/icons/) icons, or absolute URLs.
9797

98-
```javascript icon="square-js"
98+
```javascript icon=square-js
9999
const hello = "world";
100100
```
101101

@@ -109,7 +109,7 @@ const hello = "world";
109109

110110
Highlight specific lines in your code blocks using `highlight` with the line numbers or ranges you want to highlight.
111111

112-
```javascript Line Highlighting Example highlight= {1-2,5}
112+
```javascript Line Highlighting Example {1,2,5}
113113
const greeting = "Hello, World!";
114114
function sayHello() {
115115
console.log(greeting);
@@ -131,7 +131,7 @@ sayHello();
131131

132132
Focus on specific lines in your code blocks using `focus` with line numbers or ranges.
133133

134-
```javascript Line Focus Example focus= {2,4-5}
134+
```javascript Line Focus Example focus=2,4,5
135135
const greeting = "Hello, World!";
136136
function sayHello() {
137137
console.log(greeting);
@@ -304,7 +304,7 @@ sayHello();
304304

305305
Add single line comments with `[!code ++]` and `[!code --]` to mark added and removed lines. You can also mark multiple lines with a single comment, such as `[!code ++:3]` or `[!code --:5]`.
306306

307-
```js Diff Example icon="code" lines
307+
```js Diff Example icon=code lines
308308
const greeting = "Hello, World!"; // [!code ++]
309309
function sayHello() {
310310
console.log("Hello, World!"); // [!code --]

0 commit comments

Comments
 (0)