Skip to content

Commit cc35e6a

Browse files
actions-useractions-user
committed
chore: format code
1 parent 3281888 commit cc35e6a

19 files changed

Lines changed: 120 additions & 176 deletions

‎packages/docs/README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,4 +40,5 @@ Install our GitHub app from your [dashboard](https://dashboard.mintlify.com/sett
4040
- If a page loads as a 404: Make sure you are running in a folder with a valid `docs.json`.
4141

4242
### Resources
43+
4344
- [Mintlify documentation](https://mintlify.com/docs)

‎packages/docs/ai-tools/claude-code.mdx‎

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ Claude Code is Anthropic's official CLI tool. This guide will help you set up Cl
1414

1515
1. Install Claude Code globally:
1616

17-
```bash
18-
npm install -g @anthropic-ai/claude-code
17+
```bash
18+
npm install -g @anthropic-ai/claude-code
1919
```
2020

2121
2. Navigate to your docs directory.
@@ -26,20 +26,23 @@ Claude Code is Anthropic's official CLI tool. This guide will help you set up Cl
2626

2727
Create a `CLAUDE.md` file at the root of your documentation repository to train Claude Code on your specific documentation standards:
2828

29-
````markdown
29+
```markdown
3030
# Mintlify documentation
3131

3232
## Working relationship
33+
3334
- You can push back on ideas-this can lead to better documentation. Cite sources and explain your reasoning when you do so
3435
- ALWAYS ask for clarification rather than making assumptions
3536
- NEVER lie, guess, or make up information
3637

3738
## Project context
39+
3840
- Format: MDX files with YAML frontmatter
3941
- Config: docs.json for navigation, theme, settings
4042
- Components: Mintlify components
4143

4244
## Content strategy
45+
4346
- Document just enough for user success - not too much, not too little
4447
- Prioritize accuracy and usability of information
4548
- Make content evergreen when possible
@@ -48,10 +51,12 @@ Create a `CLAUDE.md` file at the root of your documentation repository to train
4851
- Start by making the smallest reasonable changes
4952

5053
## Frontmatter requirements for pages
54+
5155
- title: Clear, descriptive page title
5256
- description: Concise summary for SEO/navigation
5357

5458
## Writing standards
59+
5560
- Second-person voice ("you")
5661
- Prerequisites at start of procedural content
5762
- Test all code examples before publishing
@@ -62,15 +67,17 @@ Create a `CLAUDE.md` file at the root of your documentation repository to train
6267
- Relative paths for internal links
6368

6469
## Git workflow
70+
6571
- NEVER use --no-verify when committing
6672
- Ask how to handle uncommitted changes before starting
6773
- Create a new branch when no clear branch exists for changes
6874
- Commit frequently throughout development
6975
- NEVER skip or disable pre-commit hooks
7076

7177
## Do not
78+
7279
- Skip frontmatter on any MDX file
7380
- Use absolute URLs for internal links
7481
- Include untested code examples
7582
- Make assumptions - always ask for clarification
76-
````
83+
```

‎packages/docs/ai-tools/cursor.mdx‎

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -99,12 +99,12 @@ Example of a single code block:
9999

100100
```javascript config.js
101101
const apiConfig = {
102-
baseURL: 'https://api.example.com',
102+
baseURL: "https://api.example.com",
103103
timeout: 5000,
104104
headers: {
105-
'Authorization': `Bearer ${process.env.API_TOKEN}`
106-
}
107-
};
105+
Authorization: `Bearer ${process.env.API_TOKEN}`,
106+
},
107+
}
108108
```
109109

110110
#### Code group with multiple languages
@@ -120,14 +120,15 @@ const response = await fetch('/api/endpoint', {
120120

121121
```python Python
122122
import requests
123-
response = requests.get('/api/endpoint',
123+
response = requests.get('/api/endpoint',
124124
headers={'Authorization': f'Bearer {api_key}'})
125125
```
126126

127127
```curl cURL
128128
curl -X GET '/api/endpoint' \
129129
-H 'Authorization: Bearer YOUR_API_KEY'
130130
```
131+
131132
</CodeGroup>
132133

133134
#### Request/response examples
@@ -328,10 +329,11 @@ Wrap all images in frames:
328329
Use the HTML video element for self-hosted video content:
329330

330331
<video
331-
controls
332-
className="w-full aspect-video rounded-xl"
333-
src="link-to-your-video.com"
334-
></video>
332+
controls
333+
className="w-full aspect-video rounded-xl"
334+
src="link-to-your-video.com"
335+
336+
> </video>
335337
336338
Embed YouTube videos using iframe elements:
337339

@@ -362,9 +364,10 @@ Use updates for changelogs:
362364
- Improved error messages with actionable suggestions
363365

364366
## Bug fixes
367+
365368
- Fixed pagination issue with large datasets
366369
- Resolved authentication timeout problems
367-
</Update>
370+
</Update>
368371

369372
## Required page structure
370373

‎packages/docs/ai-tools/windsurf.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Create `.windsurf/rules.md` in your project root:
2323
## Project context
2424

2525
- This is a documentation project on the Mintlify platform
26-
- We use MDX files with YAML frontmatter
26+
- We use MDX files with YAML frontmatter
2727
- Navigation is configured in `docs.json`
2828
- We follow technical writing best practices
2929

@@ -53,7 +53,7 @@ description: "Concise description for SEO and navigation"
5353

5454
- `<Note>` for helpful supplementary information
5555
- `<Warning>` for important cautions and breaking changes
56-
- `<Tip>` for best practices and expert advice
56+
- `<Tip>` for best practices and expert advice
5757
- `<Info>` for neutral contextual information
5858
- `<Check>` for success confirmations
5959

@@ -80,7 +80,7 @@ description: "Concise description for SEO and navigation"
8080

8181
## API documentation requirements
8282

83-
- Document all parameters with `<ParamField>`
83+
- Document all parameters with `<ParamField>`
8484
- Show response structure with `<ResponseField>`
8585
- Include both success and error examples
8686
- Use `<Expandable>` for nested object properties

‎packages/docs/api-reference/endpoint/create.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
---
2-
title: 'Create Plant'
3-
openapi: 'POST /plants'
2+
title: "Create Plant"
3+
openapi: "POST /plants"
44
---

‎packages/docs/api-reference/endpoint/delete.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
---
2-
title: 'Delete Plant'
3-
openapi: 'DELETE /plants/{id}'
2+
title: "Delete Plant"
3+
openapi: "DELETE /plants/{id}"
44
---

‎packages/docs/api-reference/endpoint/get.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
---
2-
title: 'Get Plants'
3-
openapi: 'GET /plants'
2+
title: "Get Plants"
3+
openapi: "GET /plants"
44
---

‎packages/docs/api-reference/endpoint/webhook.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
---
2-
title: 'New Plant'
3-
openapi: 'WEBHOOK /plant/webhook'
2+
title: "New Plant"
3+
openapi: "WEBHOOK /plant/webhook"
44
---

‎packages/docs/api-reference/introduction.mdx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
title: 'Introduction'
3-
description: 'Example section for showcasing API endpoints'
2+
title: "Introduction"
3+
description: "Example section for showcasing API endpoints"
44
---
55

66
<Note>
7-
If you're not looking to build API reference documentation, you can delete
8-
this section by removing the api-reference folder.
7+
If you're not looking to build API reference documentation, you can delete this section by removing the api-reference
8+
folder.
99
</Note>
1010

1111
## Welcome

‎packages/docs/development.mdx‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,9 @@
11
---
2-
title: 'Development'
3-
description: 'Preview changes locally to update your docs'
2+
title: "Development"
3+
description: "Preview changes locally to update your docs"
44
---
55

6-
<Info>
7-
**Prerequisites**:
8-
- Node.js version 19 or higher
9-
- A docs repository with a `docs.json` file
10-
</Info>
6+
<Info>**Prerequisites**: - Node.js version 19 or higher - A docs repository with a `docs.json` file</Info>
117

128
Follow these steps to install and run Mintlify on your operating system.
139

@@ -17,6 +13,7 @@ Follow these steps to install and run Mintlify on your operating system.
1713
```bash
1814
npm i -g mint
1915
```
16+
2017
</Step>
2118

2219
<Step title="Preview locally">
@@ -67,7 +64,11 @@ mint broken-links
6764
If the deployment is successful, you should see the following:
6865

6966
<Frame>
70-
<img src="/images/checks-passed.png" alt="Screenshot of a deployment confirmation message that says All checks have passed." style={{ borderRadius: '0.5rem' }} />
67+
<img
68+
src="/images/checks-passed.png"
69+
alt="Screenshot of a deployment confirmation message that says All checks have passed."
70+
style={{ borderRadius: "0.5rem" }}
71+
/>
7172
</Frame>
7273

7374
## Code formatting
@@ -83,6 +84,7 @@ We suggest using extensions on your IDE to recognize and format MDX. If you're a
8384
1. Remove the currently-installed version of the CLI: `npm remove -g mint`
8485
2. Upgrade to Node v19 or higher.
8586
3. Reinstall the CLI: `npm i -g mint`
87+
8688
</Accordion>
8789

8890
<Accordion title="Issue: Encountering an unknown error">

0 commit comments

Comments
 (0)