clone/opencode
1
0
Fork 0
mirror of https://github.com/anomalyco/opencode.git synced 2026-02-01 22:48:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: format code

Browse Source
This commit is contained in:
GitHub Action
2025-12-05 21:42:15 +00:00
parent 3281888160
commit cc35e6a019
19 changed files with 120 additions and 176 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
packages/docs/README.md
View File

@@ -40,4 +40,5 @@ Install our GitHub app from your [dashboard](https://dashboard.mintlify.com/sett
- If a page loads as a 404: Make sure you are running in a folder with a valid `docs.json`.
### Resources
- [Mintlify documentation](https://mintlify.com/docs)

15
packages/docs/ai-tools/claude-code.mdx
View File

@@ -14,8 +14,8 @@ Claude Code is Anthropic's official CLI tool. This guide will help you set up Cl
1. Install Claude Code globally:
```bash
npm install -g @anthropic-ai/claude-code
```bash
npm install -g @anthropic-ai/claude-code
```
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
Create a `CLAUDE.md` file at the root of your documentation repository to train Claude Code on your specific documentation standards:
````markdown
```markdown
# Mintlify documentation
## Working relationship
- You can push back on ideas-this can lead to better documentation. Cite sources and explain your reasoning when you do so
- ALWAYS ask for clarification rather than making assumptions
- NEVER lie, guess, or make up information
## Project context
- Format: MDX files with YAML frontmatter
- Config: docs.json for navigation, theme, settings
- Components: Mintlify components
## Content strategy
- Document just enough for user success - not too much, not too little
- Prioritize accuracy and usability of information
- Make content evergreen when possible
@@ -48,10 +51,12 @@ Create a `CLAUDE.md` file at the root of your documentation repository to train
- Start by making the smallest reasonable changes
## Frontmatter requirements for pages
- title: Clear, descriptive page title
- description: Concise summary for SEO/navigation
## Writing standards
- Second-person voice ("you")
- Prerequisites at start of procedural content
- Test all code examples before publishing
@@ -62,6 +67,7 @@ Create a `CLAUDE.md` file at the root of your documentation repository to train
- Relative paths for internal links
## Git workflow
- NEVER use --no-verify when committing
- Ask how to handle uncommitted changes before starting
- Create a new branch when no clear branch exists for changes
@@ -69,8 +75,9 @@ Create a `CLAUDE.md` file at the root of your documentation repository to train
- NEVER skip or disable pre-commit hooks
## Do not
- Skip frontmatter on any MDX file
- Use absolute URLs for internal links
- Include untested code examples
- Make assumptions - always ask for clarification
````
```

23
packages/docs/ai-tools/cursor.mdx
View File

@@ -99,12 +99,12 @@ Example of a single code block:
```javascript config.js
const apiConfig = {
baseURL: 'https://api.example.com',
baseURL: "https://api.example.com",
timeout: 5000,
headers: {
'Authorization': `Bearer ${process.env.API_TOKEN}`
}
};
Authorization: `Bearer ${process.env.API_TOKEN}`,
},
}
```
#### Code group with multiple languages
@@ -120,7 +120,7 @@ const response = await fetch('/api/endpoint', {
```python Python
import requests
response = requests.get('/api/endpoint',
response = requests.get('/api/endpoint',
headers={'Authorization': f'Bearer {api_key}'})
```
@@ -128,6 +128,7 @@ response = requests.get('/api/endpoint',
curl -X GET '/api/endpoint' \
-H 'Authorization: Bearer YOUR_API_KEY'
```
</CodeGroup>
#### Request/response examples
@@ -328,10 +329,11 @@ Wrap all images in frames:
Use the HTML video element for self-hosted video content:
<video
controls
className="w-full aspect-video rounded-xl"
src="link-to-your-video.com"
></video>
controls
className="w-full aspect-video rounded-xl"
src="link-to-your-video.com"
> </video>
Embed YouTube videos using iframe elements:
@@ -362,9 +364,10 @@ Use updates for changelogs:
- Improved error messages with actionable suggestions
## Bug fixes
- Fixed pagination issue with large datasets
- Resolved authentication timeout problems
</Update>
</Update>
## Required page structure

6
packages/docs/ai-tools/windsurf.mdx
View File

@@ -23,7 +23,7 @@ Create `.windsurf/rules.md` in your project root:
## Project context
- This is a documentation project on the Mintlify platform
- We use MDX files with YAML frontmatter
- We use MDX files with YAML frontmatter
- Navigation is configured in `docs.json`
- We follow technical writing best practices
@@ -53,7 +53,7 @@ description: "Concise description for SEO and navigation"
- `<Note>` for helpful supplementary information
- `<Warning>` for important cautions and breaking changes
- `<Tip>` for best practices and expert advice
- `<Tip>` for best practices and expert advice
- `<Info>` for neutral contextual information
- `<Check>` for success confirmations
@@ -80,7 +80,7 @@ description: "Concise description for SEO and navigation"
## API documentation requirements
- Document all parameters with `<ParamField>`
- Document all parameters with `<ParamField>`
- Show response structure with `<ResponseField>`
- Include both success and error examples
- Use `<Expandable>` for nested object properties

4
packages/docs/api-reference/endpoint/create.mdx
View File

@@ -1,4 +1,4 @@
---
title: 'Create Plant'
openapi: 'POST /plants'
title: "Create Plant"
openapi: "POST /plants"
---

4
packages/docs/api-reference/endpoint/delete.mdx
View File

@@ -1,4 +1,4 @@
---
title: 'Delete Plant'
openapi: 'DELETE /plants/{id}'
title: "Delete Plant"
openapi: "DELETE /plants/{id}"
---

4
packages/docs/api-reference/endpoint/get.mdx
View File

@@ -1,4 +1,4 @@
---
title: 'Get Plants'
openapi: 'GET /plants'
title: "Get Plants"
openapi: "GET /plants"
---

4
packages/docs/api-reference/endpoint/webhook.mdx
View File

@@ -1,4 +1,4 @@
---
title: 'New Plant'
openapi: 'WEBHOOK /plant/webhook'
title: "New Plant"
openapi: "WEBHOOK /plant/webhook"
---

8
packages/docs/api-reference/introduction.mdx
View File

@@ -1,11 +1,11 @@
---
title: 'Introduction'
description: 'Example section for showcasing API endpoints'
title: "Introduction"
description: "Example section for showcasing API endpoints"
---
<Note>
If you're not looking to build API reference documentation, you can delete
this section by removing the api-reference folder.
If you're not looking to build API reference documentation, you can delete this section by removing the api-reference
folder.
</Note>
## Welcome

18
packages/docs/development.mdx
View File

@@ -1,13 +1,9 @@
---
title: 'Development'
description: 'Preview changes locally to update your docs'
title: "Development"
description: "Preview changes locally to update your docs"
---
<Info>
**Prerequisites**:
- Node.js version 19 or higher
- A docs repository with a `docs.json` file
</Info>
<Info>**Prerequisites**: - Node.js version 19 or higher - A docs repository with a `docs.json` file</Info>
Follow these steps to install and run Mintlify on your operating system.
@@ -17,6 +13,7 @@ Follow these steps to install and run Mintlify on your operating system.
```bash
npm i -g mint
```
</Step>
<Step title="Preview locally">
@@ -67,7 +64,11 @@ mint broken-links
If the deployment is successful, you should see the following:
<Frame>
<img src="/images/checks-passed.png" alt="Screenshot of a deployment confirmation message that says All checks have passed." style={{ borderRadius: '0.5rem' }} />
<img
src="/images/checks-passed.png"
alt="Screenshot of a deployment confirmation message that says All checks have passed."
style={{ borderRadius: "0.5rem" }}
/>
</Frame>
## Code formatting
@@ -83,6 +84,7 @@ We suggest using extensions on your IDE to recognize and format MDX. If you're a
1. Remove the currently-installed version of the CLI: `npm remove -g mint`
2. Upgrade to Node v19 or higher.
3. Reinstall the CLI: `npm i -g mint`
</Accordion>
<Accordion title="Issue: Encountering an unknown error">

39
packages/docs/docs.json
View File

@@ -15,35 +15,19 @@
"groups": [
{
"group": "Getting started",
"pages": [
"index",
"quickstart",
"development"
]
"pages": ["index", "quickstart", "development"]
},
{
"group": "Customization",
"pages": [
"essentials/settings",
"essentials/navigation"
]
"pages": ["essentials/settings", "essentials/navigation"]
},
{
"group": "Writing content",
"pages": [
"essentials/markdown",
"essentials/code",
"essentials/images",
"essentials/reusable-snippets"
]
"pages": ["essentials/markdown", "essentials/code", "essentials/images", "essentials/reusable-snippets"]
},
{
"group": "AI tools",
"pages": [
"ai-tools/cursor",
"ai-tools/claude-code",
"ai-tools/windsurf"
]
"pages": ["ai-tools/cursor", "ai-tools/claude-code", "ai-tools/windsurf"]
}
]
},
@@ -52,9 +36,7 @@
"groups": [
{
"group": "API documentation",
"pages": [
"api-reference/introduction"
]
"pages": ["api-reference/introduction"]
},
{
"group": "Endpoint examples",
@@ -101,16 +83,7 @@
}
},
"contextual": {
"options": [
"copy",
"view",
"chatgpt",
"claude",
"perplexity",
"mcp",
"cursor",
"vscode"
]
"options": ["copy", "view", "chatgpt", "claude", "perplexity", "mcp", "cursor", "vscode"]
},
"footer": {
"socials": {

6
packages/docs/essentials/code.mdx
View File

@@ -1,7 +1,7 @@
---
title: 'Code blocks'
description: 'Display inline code and code blocks'
icon: 'code'
title: "Code blocks"
description: "Display inline code and code blocks"
icon: "code"
---
## Inline code

13
packages/docs/essentials/images.mdx
View File

@@ -1,13 +1,10 @@
---
title: 'Images and embeds'
description: 'Add image, video, and other HTML elements'
icon: 'image'
title: "Images and embeds"
description: "Add image, video, and other HTML elements"
icon: "image"
---
<img
style={{ borderRadius: '0.5rem' }}
src="https://mintlify-assets.b-cdn.net/bigbend.jpg"
/>
<img style={{ borderRadius: "0.5rem" }} src="https://mintlify-assets.b-cdn.net/bigbend.jpg" />
## Image
@@ -39,7 +36,7 @@ To get more customizability with images, you can also use [embeds](/writing-cont
frameBorder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
allowFullScreen
style={{ width: '100%', borderRadius: '0.5rem' }}
style={{ width: "100%", borderRadius: "0.5rem" }}
></iframe>
<br />

6
packages/docs/essentials/markdown.mdx
View File

@@ -1,7 +1,7 @@
---
title: 'Markdown syntax'
description: 'Text, title, and styling in standard markdown'
icon: 'text-size'
title: "Markdown syntax"
description: "Text, title, and styling in standard markdown"
icon: "text-size"
---
## Titles

6
packages/docs/essentials/navigation.mdx
View File

@@ -1,7 +1,7 @@
---
title: 'Navigation'
description: 'The navigation field in docs.json defines the pages that go in the navigation menu'
icon: 'map'
title: "Navigation"
description: "The navigation field in docs.json defines the pages that go in the navigation menu"
icon: "map"
---
The navigation menu is the list of links on every website.

32
packages/docs/essentials/reusable-snippets.mdx
View File

@@ -4,7 +4,7 @@ description: "Reusable, custom snippets to keep content in sync"
icon: "recycle"
---
import SnippetIntro from '/snippets/snippet-intro.mdx';
import SnippetIntro from "/snippets/snippet-intro.mdx"
<SnippetIntro />
@@ -13,9 +13,8 @@ import SnippetIntro from '/snippets/snippet-intro.mdx';
**Pre-condition**: You must create your snippet file in the `snippets` directory.
<Note>
Any page in the `snippets` directory will be treated as a snippet and will not
be rendered into a standalone page. If you want to create a standalone page
from the snippet, import the snippet into another file and call it as a
Any page in the `snippets` directory will be treated as a snippet and will not be rendered into a standalone page. If
you want to create a standalone page from the snippet, import the snippet into another file and call it as a
component.
</Note>
@@ -31,8 +30,7 @@ day is {word}.
```
<Warning>
The content that you want to reuse must be inside the `snippets` directory in
order for the import to work.
The content that you want to reuse must be inside the `snippets` directory in order for the import to work.
</Warning>
2. Import the snippet into your destination file.
@@ -43,7 +41,7 @@ title: My title
description: My Description
---
import MySnippet from '/snippets/path/to/my-snippet.mdx';
import MySnippet from "/snippets/path/to/my-snippet.mdx"
## Header
@@ -57,9 +55,11 @@ Lorem impsum dolor sit amet.
1. Export a variable from your snippet file:
```mdx snippets/path/to/custom-variables.mdx
export const myName = 'my name';
export const myName = "my name"
export const myObject = { fruit: 'strawberries' };
export const myObject = { fruit: "strawberries" }
;
```
2. Import the snippet from your destination file and use the variable:
@@ -70,7 +70,7 @@ title: My title
description: My Description
---
import { myName, myObject } from '/snippets/path/to/custom-variables.mdx';
import { myName, myObject } from "/snippets/path/to/custom-variables.mdx"
Hello, my name is {myName} and I like {myObject.fruit}.
```
@@ -86,12 +86,14 @@ export const MyComponent = ({ title }) => (
<h1>{title}</h1>
<p>... snippet content ...</p>
</div>
);
)
;
```
<Warning>
MDX does not compile inside the body of an arrow function. Stick to HTML
syntax when you can or use a default export if you need to use MDX.
MDX does not compile inside the body of an arrow function. Stick to HTML syntax when you can or use a default export
if you need to use MDX.
</Warning>
2. Import the snippet into your destination file and pass in the props
@@ -102,9 +104,9 @@ title: My title
description: My Description
---
import { MyComponent } from '/snippets/custom-component.mdx';
import { MyComponent } from "/snippets/custom-component.mdx"
Lorem ipsum dolor sit amet.
<MyComponent title={'Custom title'} />
<MyComponent title={"Custom title"} />
```

25
packages/docs/essentials/settings.mdx
View File

@@ -1,7 +1,7 @@
---
title: 'Global Settings'
description: 'Mintlify gives you complete control over the look and feel of your documentation using the docs.json file'
icon: 'gear'
title: "Global Settings"
description: "Mintlify gives you complete control over the look and feel of your documentation using the docs.json file"
icon: "gear"
---
Every Mintlify site needs a `docs.json` file with the core configuration settings. Learn more about the [properties](#properties) below.
@@ -57,12 +57,11 @@ Example: `mintlify`
Hex color codes for your global theme
<Expandable title="Colors">
<ResponseField name="primary" type="string" required>
The primary color. Used for most often for highlighted content, section
headers, accents, in light mode
The primary color. Used for most often for highlighted content, section headers, accents, in light mode
</ResponseField>
<ResponseField name="light" type="string">
The primary color for dark mode. Used for most often for highlighted
content, section headers, accents, in dark mode
The primary color for dark mode. Used for most often for highlighted content, section headers, accents, in dark
mode
</ResponseField>
<ResponseField name="dark" type="string">
The primary color for important buttons
@@ -114,8 +113,8 @@ Example: `mintlify`
</ResponseField>
<ResponseField name="versions" type="string[]">
Array of version names. Only use this if you want to show different versions
of docs with a dropdown in the navigation bar.
Array of version names. Only use this if you want to show different versions of docs with a dropdown in the navigation
bar.
</ResponseField>
<ResponseField name="anchors" type="Anchor[]">
@@ -172,8 +171,8 @@ Example: `mintlify`
The name of the tab label.
</ResponseField>
<ResponseField name="url" type="string">
The start of the URL that marks what pages go in the tab. Generally, this
is the name of the folder you put your pages in.
The start of the URL that marks what pages go in the tab. Generally, this is the name of the folder you put your
pages in.
</ResponseField>
</Expandable>
</ResponseField>
@@ -313,6 +312,6 @@ Example: `mintlify`
</ResponseField>
<ResponseField name="backgroundImage" type="string">
A background image to be displayed behind every page. See example with
[Infisical](https://infisical.com/docs) and [FRPC](https://frpc.io).
A background image to be displayed behind every page. See example with [Infisical](https://infisical.com/docs) and
[FRPC](https://frpc.io).
</ResponseField>

61
packages/docs/index.mdx
View File

@@ -7,12 +7,7 @@ description: "Welcome to the new home for your documentation"
Get your documentation site up and running in minutes.
<Card
title="Start here"
icon="rocket"
href="/quickstart"
horizontal
>
<Card title="Start here" icon="rocket" href="/quickstart" horizontal>
Follow our three step quickstart guide.
</Card>
@@ -21,32 +16,16 @@ Get your documentation site up and running in minutes.
Design a docs site that looks great and empowers your users.
<Columns cols={2}>
<Card
title="Edit locally"
icon="pen-to-square"
href="/development"
>
<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"
>
<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"
>
<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"
>
<Card title="API documentation" icon="terminal" href="/api-reference/introduction">
Auto-generate API documentation from OpenAPI specifications.
</Card>
</Columns>
@@ -56,42 +35,22 @@ Design a docs site that looks great and empowers your users.
Everything you need to create world-class documentation.
<Columns cols={2}>
<Card
title="Write with MDX"
icon="pen-fancy"
href="/essentials/markdown"
>
<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"
>
<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"
>
<Card title="Images" icon="image" href="/essentials/images">
Display images and other media.
</Card>
<Card
title="Reusable snippets"
icon="recycle"
href="/essentials/reusable-snippets"
>
<Card title="Reusable snippets" icon="recycle" href="/essentials/reusable-snippets">
Write once and reuse across your docs.
</Card>
</Columns>
## Need inspiration?
<Card
title="See complete examples"
icon="stars"
href="https://mintlify.com/customers"
>
<Card title="See complete examples" icon="stars" href="https://mintlify.com/customers">
Browse our showcase of exceptional documentation sites.
</Card>

21
packages/docs/quickstart.mdx
View File

@@ -11,15 +11,15 @@ Get your documentation site running locally and make your first customization.
<AccordionGroup>
<Accordion icon="copy" title="Clone your docs locally">
During the onboarding process, you created a GitHub repository with your docs content if you didn't already have one. You can find a link to this repository in your [dashboard](https://dashboard.mintlify.com).
To clone the repository locally so that you can make and preview changes to your docs, follow the [Cloning a repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) guide in the GitHub docs.
During the onboarding process, you created a GitHub repository with your docs content if you didn't already have
one. You can find a link to this repository in your [dashboard](https://dashboard.mintlify.com). To clone the
repository locally so that you can make and preview changes to your docs, follow the [Cloning a
repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) guide
in the GitHub docs.
</Accordion>
<Accordion icon="rectangle-terminal" title="Start the preview server">
1. Install the Mintlify CLI: `npm i -g mint`
2. Navigate to your docs directory and run: `mint dev`
3. Open `http://localhost:3000` to see your docs live!
1. Install the Mintlify CLI: `npm i -g mint` 2. Navigate to your docs directory and run: `mint dev` 3. Open
`http://localhost:3000` to see your docs live!
<Tip>Your preview updates automatically as you edit files.</Tip>
</Accordion>
</AccordionGroup>
@@ -41,14 +41,14 @@ Get your documentation site running locally and make your first customization.
4. Save and see your changes instantly at `http://localhost:3000`.
<Tip>Try changing the primary color to see an immediate difference!</Tip>
</Accordion>
</AccordionGroup>
### Step 3: Go live
<Accordion icon="rocket" title="Publish your docs">
1. Commit and push your changes.
2. Your docs will update and be live in moments!
1. Commit and push your changes. 2. Your docs will update and be live in moments!
</Accordion>
## Next steps
@@ -76,5 +76,6 @@ Now that you have your docs running, explore these key features:
</CardGroup>
<Note>
**Need help?** See our [full documentation](https://mintlify.com/docs) or join our [community](https://mintlify.com/community).
**Need help?** See our [full documentation](https://mintlify.com/docs) or join our
[community](https://mintlify.com/community).
</Note>