diff --git a/code.mdx b/code.mdx
index 498319a65..2a89f0362 100644
--- a/code.mdx
+++ b/code.mdx
@@ -4,38 +4,42 @@ description: "Display inline code and code blocks"
icon: 'code'
---
-## Basic
+## Inline Code
-### Inline Code
+To add inline code, wrap text in single backticks: `like this`
-To denote a `word` or `phrase` as code, enclose it in backticks (\`).
+## Code Blocks
-```
-To denote a `word` or `phrase` as code, enclose it in backticks (`).
-```
+### Basic Code Block
+Create a code block by wrapping your code in three backticks (```). Add a language name after the opening backticks for syntax highlighting.
+```python
+def hello_world():
+ print("Hello, World!")
+```
+
+```md
+\```python
+def hello_world():
+ print("Hello, World!")
+\```
+```
-### Code Block
+### Named Code Blocks
-Use [fenced code blocks](https://www.markdownguide.org/extended-syntax/#fenced-code-blocks) by enclosing code in three backticks and follow the leading ticks with the programming language of your snippet to get syntax highlighting. Optionally, you can also write the name of your code after the programming language.
+You can add a name to your code block by adding text after the language:
-```java HelloWorld.java
-class HelloWorld {
- public static void main(String[] args) {
- System.out.println("Hello, World!");
- }
-}
+```javascript hello.js
+console.log("Hello, World!");
```
-````md
-```java HelloWorld.java
-class HelloWorld {
- public static void main(String[] args) {
- System.out.println("Hello, World!");
- }
-}
+```md
+\```javascript hello.js
+console.log("Hello, World!");
+\```
```
-````
-Visit the [Code Block page](/content/components/code) for more detailed docs.
\ No newline at end of file
+
+ We use [Prism](https://prismjs.com/#supported-languages) for syntax highlighting. See their documentation for a full list of supported languages.
+
\ No newline at end of file
diff --git a/content/components/accordions.mdx b/content/components/accordions.mdx
index f4757be9b..df9e3c61f 100644
--- a/content/components/accordions.mdx
+++ b/content/components/accordions.mdx
@@ -4,41 +4,34 @@ description: "A dropdown component to toggle content"
icon: "square-caret-down"
---
-
- You can put any content in here. Check out
- [AccordionGroup](/content/components/accordion-groups) if you want to group
- multiple Accordions into a single display.
+Accordions let you hide and show content in an expandable section. They're great for FAQs or organizing long content into collapsible sections.
+
+
+ This is an example of basic accordion content. You can put text, lists, code, or any other content inside.
-
+## Usage
-```jsx Accordion Example
-
- You can put any content in here.
+```jsx
+
+ Your content goes here
```
-
-
## Props
- Title in the Accordion preview.
+ The text shown in the accordion header
-
- Detail below the title in the Accordion preview.
+
+ Set to `true` to have the accordion open by default
-
- Whether the Accordion is open by default.
+
+ Optional [Font Awesome icon](https://fontawesome.com/icons) to show next to the title
-
- A [Font Awesome icon](https://fontawesome.com/icons) or SVG code
-
-
-
- One of "regular", "solid", "light", "thin", "sharp-solid", "duotone", or
- "brands"
-
+
+ Need to group multiple accordions? Check out [AccordionGroup](/content/components/accordion-groups).
+
\ No newline at end of file
diff --git a/docs.json b/docs.json
index 381cdcce0..6d5e24aaf 100644
--- a/docs.json
+++ b/docs.json
@@ -22,7 +22,12 @@
{
"group": "Editing",
"icon": "pen-paintbrush",
- "pages": ["development", "web-editor"]
+ "pages": [
+ "development",
+ "web-editor",
+ "list-table",
+ "text"
+ ]
},
"settings/global",
{
@@ -37,7 +42,9 @@
]
},
"themes",
- "migration"
+ "migration",
+ "code",
+ "quickstart"
]
},
{
@@ -133,7 +140,10 @@
{
"group": "Dashboard Access",
"icon": "house-lock",
- "pages": ["advanced/dashboard/sso", "advanced/dashboard/permissions"]
+ "pages": [
+ "advanced/dashboard/sso",
+ "advanced/dashboard/permissions"
+ ]
},
{
"group": "REST API",
@@ -181,7 +191,8 @@
"content/components/steps",
"content/components/tabs",
"content/components/tooltips",
- "content/components/update"
+ "content/components/update",
+ "content/components/accordions"
]
},
{
@@ -205,7 +216,7 @@
"pages": [
"integrations/analytics/overview",
"integrations/analytics/amplitude",
- "integrations/analytics/clearbit",
+ "integrations/analytics/clearbit",
"integrations/analytics/fathom",
"integrations/analytics/google-analytics",
"integrations/analytics/google-tag-manager",
@@ -251,7 +262,9 @@
"groups": [
{
"group": "Changelog",
- "pages": ["changelog/overview"]
+ "pages": [
+ "changelog/overview"
+ ]
}
]
}
@@ -363,4 +376,4 @@
"publicApiKey": "pk_76a6caa274e800f3ceff0b2bc6b9b9d82ab8"
}
}
-}
+}
\ No newline at end of file
diff --git a/list-table.mdx b/list-table.mdx
index bbaef913c..1f1ff21a5 100644
--- a/list-table.mdx
+++ b/list-table.mdx
@@ -3,86 +3,55 @@ title: "Lists and Tables"
description: "Display information in lists and tables"
icon: 'list'
---
-## Lists
-### Ordered List
-
-To create an ordered list, add line items with numbers followed by periods
-
-1. First item
-2. Second item
-3. Third item
-4. Fourth item
-```md
-1. First item
-2. Second item
-3. Third item
-4. Fourth item
-```
+## Lists
-### Unordered List
+### Simple Lists
-To create an unordered list, add dashes (`-`), asterisks (`*`), or plus signs (`+`) in front of line items
+Create a list by adding dashes (`-`) in front of items:
-- First item
-- Second item
-- Third item
-- Fourth item
+- Apple
+- Banana
+- Orange
```md
-- First item
-- Second item
-- Third item
-- Fourth item
+- Apple
+- Banana
+- Orange
```
-### Nested List
-
-Add indents on list items to nest them
+For numbered lists, use numbers with periods:
-- First item
-- Second item
- - Additional item
- - Additional item
-- Third item
+1. First step
+2. Second step
+3. Third step
```md
-- First item
-- Second item
- - Additional item
- - Additional item
-- Third item
+1. First step
+2. Second step
+3. Third step
```
-
-Lists follow the official [markdown syntax](https://www.markdownguide.org/basic-syntax/#lists-1).
-
+Need more list options? Check out the [markdown syntax guide](https://www.markdownguide.org/basic-syntax/#lists-1).
## Tables
-| Property | Description |
-| -------- | ------------------------------------- |
-| Name | Full name of user |
-| Age | Reported age |
-| Joined | Whether the user joined the community |
+Create simple tables using pipes (`|`) and hyphens (`-`):
-
-### Creating a table
-
-
-
-The Table component follows the official [markdown syntax](https://www.markdownguide.org/extended-syntax/#tables).
-
-
-
-To add a table, use three or more hyphens (`---`) to create each column's header, and use pipes (`|`) to separate each column. For compatibility, you should also add a pipe on either end of the row.
+| Name | Type | Description |
+|-------|---------|-------------------|
+| id | string | Unique identifier |
+| title | string | Item title |
+| date | string | Creation date |
```md
-| Property | Description |
-| -------- | ------------------------------------- |
-| Name | Full name of user |
-| Age | Reported age |
-| Joined | Whether the user joined the community |
-```
\ No newline at end of file
+| Name | Type | Description |
+|-------|---------|-------------------|
+| id | string | Unique identifier |
+| title | string | Item title |
+| date | string | Creation date |
+```
+
+That's it! Tables are great for displaying structured data in a clear format.
\ No newline at end of file
diff --git a/quickstart.mdx b/quickstart.mdx
index bc95e6932..3d2ebb306 100644
--- a/quickstart.mdx
+++ b/quickstart.mdx
@@ -17,170 +17,58 @@ icon: "rocket"
## Getting Started
-Welcome! Follow the instructions below to learn how to deploy, update and
-supercharge your documentation with Mintlify.
+Welcome to Mintlify! Let's get your documentation up and running in three simple steps.
-### Creating the Repository
+### 1. Set Up Your Repository
-Mintlify docs are rendered from MDX files and configurations defined in our
-[starter kit](https://github.com/mintlify/starter). We use GitHub to integrate
-your docs with your code, and make source control effortless. Onboard through the [dashboard](https://dashboard.mintlify.com) or clone our [starter kit](https://github.com/mintlify/starter) to get started.
+
+
+ Clone our [starter kit](https://github.com/mintlify/starter) or create a new repository through our [dashboard](https://dashboard.mintlify.com).
+
+
+ Install our [GitHub app](https://dashboard.mintlify.com/settings) to enable automatic deployments when you push changes.
+
+
-
-
-
-
- Install our GitHub app to ensure that your updates are automatically deployed when you push changes. You can find the installation link in the [dashboard](https://dashboard.mintlify.com/settings), on the Settings page. Upon successful installation, a check mark will appear next to the commit hash of the repository.
+### 2. Edit Your Content
-
- 
-
-
-
-
-
- If you want your docs to live alongside your code as a monorepo setup, you
- can: 1. Move your docs content to your monorepo. 2. Specify the path to your
- `docs.json` in the
- [dashboard](https://dashboard.mintlify.com/settings/deployment/git-settings)
-
- 
- 
-
-
-
-
+Choose your preferred editing method:
-### Updating the Content
+
+
+ 1. Install the CLI: `npm i -g mintlify`
+ 2. Clone your repo
+ 3. Preview changes: `mintlify dev`
+
+
+ Use our web editor at [dashboard.mintlify.com](https://dashboard.mintlify.com)
+
+
-Mintlify enables you to easily customize the style, structure, and content of
-your docs.
+### 3. Customize and Deploy
-
-
- 1. Install [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).
- 2. Once git is installed, clone your docs repository using `git clone `. If you haven't set it up yet, now would be a good time to do so with these [SSH keys](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent).
- 3. Use your favorite IDE to open the repository.
- 4. Install our Mintlify CLI to preview changes with `npm i -g mintlify`.
-
- Learn more about this in our [local development guide](/development).
-
-
-
-
-
- Learn more about how to use the web editor on our [guide](/web-editor).
-
-
-
-
-
- Easily customize colors, logos and buttons among other configurations in our `docs.json` file. Start with these basic configurations:
-
- ```json
- "name": "Your Company"
- "logo": {
- "light": "/logo/light.svg",
- "dark": "/logo/dark.svg",
- "href": "https://yourcompany.com"
- },
- "favicon": "/favicon.svg",
- "colors": {
- "primary": "#2AB673",
- "light": "#55D799",
- "dark": "#117866",
- },
- ```
-
- A full list of supported configurations can be found at [global settings](/settings/global).
-
-
-
-
-
- Add content with simple MDX files. Initiate your pages with this template:
-
- ```md
- ---
- title: "Page Title"
- sidebarTitle: "Sidebar title (optional - if different from page title)"
- description: "Subtitle (optional)"
- ---
- ```
-
- Learn more about adding images, tables, lists, and more using the [MDX syntax](/text). We also offer a [wide array of components](/content/components).
-
-
-
-
-
- Once ready, commit and push your changes to update your docs site. Here is a [guide](https://docs.github.com/en/get-started/using-git/pushing-commits-to-a-remote-repository#about-git-push) on how to do that. If the GitHub app is unable to successfully deploy your changes, you can manually update your docs through our [dashboard](https://dashboard.mintlify.com).
-
-
- 
-
-
-
-
-
-
- You can easily set up your API references using an OpenAPI document.
-
- 1. Add your `openapi.yaml` or `openapi.json` file into your docs repository or define the `openapi` field in `docs.json` with a URL.
-
+
+ Update your `docs.json` with your brand details:
```json
- "openapi": "link-to-your-openapi-file"
- ```
-
- 2. Use our [scraper](/api-playground/openapi/setup#autogenerate-files-recommended) to autogenerate your OpenAPI endpoints files as:
-
- ```bash
- npx @mintlify/scraping@latest openapi-file
+ {
+ "name": "Your Company",
+ "logo": {
+ "light": "/logo/light.svg",
+ "dark": "/logo/dark.svg"
+ },
+ "colors": {
+ "primary": "#2AB673"
+ }
+ }
```
-
- 3. Finally, include the generated endpoint MDX files to your `docs.json` under `navigation`.
-
- For a complete guide on using Mintlify with OpenAPI, check out [this guide](/api-playground/openapi/setup). [This guide](/api-playground/openapi/writing-openapi) explains how to configure your API authentication methods. For manual API references definition, explore [our syntax](/api-playground/overview).
-
-
-
- Our in-house analytics give you insights into page views, search analytics, session recordings and more. Access these on your [dashboard](https://dashboard.mintlify.com/analytics).
-
- We also support integrations with a range of analytics providers. You can find the list of providers [here](/integrations/analytics/overview).
-
+
+ Simply commit and push your changes to deploy automatically. Your docs will be live within minutes!
- We provide a white-glove migration service as part of our Enterprise plan.
- Interested? You can request it by [contacting us](mailto:sales@mintlify.com).
-
-
-### Publishing
-
-
-
-Integrate your docs into your website by hosting them on a custom domain. This is included in the free plan.
-
-Navigate to your [dashboard settings](https://dashboard.mintlify.com/settings) to add a custom domain.
-
-
-
-
-
-Congrats! You've set up your Mintlify Docs and it's looking amazing! Need
-support or want to give some feedback? You can join our
-[community](https://mintlify.com/community) or drop us an email at
-[support@mintlify.com](mailto:support@mintlify.com).
+ Need help? Join our [community](https://mintlify.com/community) or email us at [support@mintlify.com](mailto:support@mintlify.com).
+
\ No newline at end of file
diff --git a/text.mdx b/text.mdx
index 45cec9193..b406bf219 100644
--- a/text.mdx
+++ b/text.mdx
@@ -6,7 +6,7 @@ icon: 'heading'
## Titles
-Best used for section headers.
+Use titles for main section headers.
```md
## Titles
@@ -14,93 +14,72 @@ Best used for section headers.
### Subtitles
-Best used for subsection headers.
+Use subtitles for subsection headers.
```md
### Subtitles
```
-
-Each **title** and **subtitle** creates an anchor and also shows up on the table of contents on the right.
-
+Titles and subtitles automatically create anchors and appear in the table of contents.
## Text Formatting
-We support most markdown formatting. Simply add `**`, `_`, or `~` around text to format it.
-
-| Style | How to write it | Result |
-| ------------- | ----------------- | --------------- |
-| Bold | `**bold**` | **bold** |
-| Italic | `_italic_` | _italic_ |
-| Strikethrough | `~strikethrough~` | ~strikethrough~ |
-
-You can combine these. For example, write `**_bold and italic_**` to get **_bold and italic_** text.
+Format your text using markdown syntax:
-You need to use HTML to write superscript and subscript text. That is, add `` or `` around your text.
+- Bold: `**text**` → **text**
+- Italic: `_text_` → _text_
+- Strikethrough: `~text~` → ~text~
-| Text Size | How to write it | Result |
-| ----------- | ------------------------ | ---------------------- |
-| Superscript | `superscript` | superscript |
-| Subscript | `subscript` | subscript |
+You can combine these formats, like `**_bold and italic_**` → **_bold and italic_**
-## Linking to Pages
+For superscript and subscript text, use HTML tags:
+- Superscript: `text` → x2
+- Subscript: `text` → H2O
-You can add a link by wrapping text in `[]()`. You would write `[link to google](https://google.com)` to [link to google](https://google.com).
+## Links
-Links to pages in your docs need to be root-relative. Basically, you should include the entire folder path. For example, `[link to text](/content/text)` links to the page "Text" in our components section.
+Create links using `[text](url)`. For example:
+`[Mintlify Documentation](https://mintlify.com)` → [Mintlify Documentation](https://mintlify.com)
-Relative links like `[link to text](../text)` will open slower because we cannot optimize them as easily.
-
-You can validate broken links in your docs with [our CLI](/development).
+When linking to other pages in your docs, use root-relative paths:
+`[Text Formatting](/content/text)` → [Text Formatting](/content/text)
## Blockquotes
-### Singleline
-
-To create a blockquote, add a `>` in front of a paragraph.
+Add a `>` before text to create a blockquote:
-> Dorothy followed her through many of the beautiful rooms in her castle.
+> This is a blockquote example.
```md
-> Dorothy followed her through many of the beautiful rooms in her castle.
+> This is a blockquote example.
```
-### Multiline
-
-> Dorothy followed her through many of the beautiful rooms in her castle.
->
-> The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.
+For multiple paragraphs, use `>` on blank lines between them:
-```md
-> Dorothy followed her through many of the beautiful rooms in her castle.
+> First paragraph
>
-> The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.
-```
+> Second paragraph
-### LaTeX
+## LaTeX
-Mintlify supports in-line [LaTeX](https://www.latex-project.org) by surrounding your LaTeX code with dollar signs (\$). For example, `$(a^2 + b^2 = c^2)$` will render as $(a^2 + b^2 = c^2)$.
+Use single `$` for inline math: `$E = mc^2$` → $E = mc^2$
-Equations on their own line can be created with double dollar signs (\$\$):
+Use double `$$` for block math:
-$$\exists \, x \notin [0,1]$$
+$$\sum_{n=1}^{\infty} \frac{1}{n^2} = \frac{\pi^2}{6}$$
-```md
-$$\exists \, x \notin [0,1]$$
-```
+## Line Breaks
-### Line Breaks
+Create line breaks by adding a blank line between paragraphs:
-Markdown syntax also recognizes a double enter in your MDX as a linebreak.
+Like
-```html
-
-```
+This
```md
-Paragraph 1
+Like
-Paragraph 2
-```
+This
+```
\ No newline at end of file