summaryrefslogtreecommitdiffhomepage
path: root/packages/docs/essentials
diff options
context:
space:
mode:
authorGitHub Action <[email protected]>2025-12-05 21:42:15 +0000
committerGitHub Action <[email protected]>2025-12-05 21:42:15 +0000
commitcc35e6a0191c6f9c22c0573f1ea5f96775fc32bd (patch)
tree2c4121941c2a979df56339677db815d4bf77036f /packages/docs/essentials
parent328188816008fde10165597f432dac4c5d1016cd (diff)
downloadopencode-cc35e6a0191c6f9c22c0573f1ea5f96775fc32bd.tar.gz
opencode-cc35e6a0191c6f9c22c0573f1ea5f96775fc32bd.zip
chore: format code
Diffstat (limited to 'packages/docs/essentials')
-rw-r--r--packages/docs/essentials/code.mdx6
-rw-r--r--packages/docs/essentials/images.mdx13
-rw-r--r--packages/docs/essentials/markdown.mdx6
-rw-r--r--packages/docs/essentials/navigation.mdx6
-rw-r--r--packages/docs/essentials/reusable-snippets.mdx32
-rw-r--r--packages/docs/essentials/settings.mdx25
6 files changed, 43 insertions, 45 deletions
diff --git a/packages/docs/essentials/code.mdx b/packages/docs/essentials/code.mdx
index ae2abbfec..7a0465447 100644
--- a/packages/docs/essentials/code.mdx
+++ b/packages/docs/essentials/code.mdx
@@ -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
diff --git a/packages/docs/essentials/images.mdx b/packages/docs/essentials/images.mdx
index 1144eb2cc..f2a10d253 100644
--- a/packages/docs/essentials/images.mdx
+++ b/packages/docs/essentials/images.mdx
@@ -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 />
diff --git a/packages/docs/essentials/markdown.mdx b/packages/docs/essentials/markdown.mdx
index a45c1d569..0ca5b8250 100644
--- a/packages/docs/essentials/markdown.mdx
+++ b/packages/docs/essentials/markdown.mdx
@@ -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
diff --git a/packages/docs/essentials/navigation.mdx b/packages/docs/essentials/navigation.mdx
index 60adeff23..a6a309004 100644
--- a/packages/docs/essentials/navigation.mdx
+++ b/packages/docs/essentials/navigation.mdx
@@ -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.
diff --git a/packages/docs/essentials/reusable-snippets.mdx b/packages/docs/essentials/reusable-snippets.mdx
index 376e27bd9..a26ab89a3 100644
--- a/packages/docs/essentials/reusable-snippets.mdx
+++ b/packages/docs/essentials/reusable-snippets.mdx
@@ -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"} />
```
diff --git a/packages/docs/essentials/settings.mdx b/packages/docs/essentials/settings.mdx
index 884de13a4..7aa44ce1e 100644
--- a/packages/docs/essentials/settings.mdx
+++ b/packages/docs/essentials/settings.mdx
@@ -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>