Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions .github/workflows/check-links.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Check links

on: pull_request

jobs:
check-links:
name: Check links
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Node
uses: actions/setup-node@v4
with:
node-version: "latest"
- name: Install Mintlify CLI
run: npm i -g mintlify
- name: Run broken link checker
run: mintlify broken-links
86 changes: 0 additions & 86 deletions component-library.mdx

This file was deleted.

19 changes: 10 additions & 9 deletions content/components/accordions.mdx
Original file line number Diff line number Diff line change
@@ -1,22 +1,23 @@
---
title: 'Accordions'
description: 'A dropdown component for toggling content'
icon: 'square-caret-down'
title: "Accordions"
description: "A dropdown component for toggling content"
icon: "square-caret-down"
---

<Accordion title="I am an Accordion.">
You can put any content in here. Check out
[AccordionGroup](/content/components/accordion-group) if you want to group
[AccordionGroup](/content/components/accordion-groups) if you want to group
multiple Accordions into a single display.
</Accordion>

<RequestExample>

```jsx Accordion Example
<Accordion title="I am an Accordion.">
You can put any content in here.
</Accordion>
```
```jsx Accordion Example
<Accordion title="I am an Accordion.">
You can put any content in here.
</Accordion>
```

</RequestExample>

## Props
Expand Down
58 changes: 0 additions & 58 deletions embed.mdx

This file was deleted.

20 changes: 14 additions & 6 deletions quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,14 @@ icon: "rocket"

## Getting Started

Welcome to the Mintlify documentation guide. Follow the instructions below to learn how to deploy, update and supercharge your documentation with Mintlify.
Welcome to the Mintlify documentation guide. Follow the instructions below to
learn how to deploy, update and supercharge your documentation with Mintlify.

### 1. Deploying Your Docs Repository

Mintlify docs are rendered from MDX files and configurations defined in our [starter template](https://github.com/mintlify/starter). We use Github to integrate your docs with your code, and make source control effortless.
Mintlify docs are rendered from MDX files and configurations defined in our
[starter template](https://github.com/mintlify/starter). We use Github to
integrate your docs with your code, and make source control effortless.

<AccordionGroup>
<Accordion icon="github" title="Creating Your Documentation Repository">
Expand All @@ -46,7 +49,8 @@ Mintlify docs are rendered from MDX files and configurations defined in our [sta

### 2. Updating Your Docs

Mintlify enables you to easily customize the style, structure, and content of your docs.
Mintlify enables you to easily customize the style, structure, and content of
your docs.

<Note>
We provide a white-glove migration service as part of our startup plan.
Expand Down Expand Up @@ -108,7 +112,7 @@ Mintlify enables you to easily customize the style, structure, and content of yo
---
```

Learn more about adding images, tables, lists, and more using the [MDX syntax](/content/text). We also offer a wide array of components which are listed [here](/content/components).
Learn more about adding images, tables, lists, and more using the [MDX syntax](/text). We also offer a wide array of components which are listed [here](/content/components).

</Accordion>

Expand All @@ -123,7 +127,8 @@ Mintlify enables you to easily customize the style, structure, and content of yo

### 3. Supercharging Your Docs

Mintlify supports an array of advanced features like API reference docs, analytics, and versioning to accommodate any of your documentation needs.
Mintlify supports an array of advanced features like API reference docs,
analytics, and versioning to accommodate any of your documentation needs.

<AccordionGroup>
<Accordion icon="code-branch" title="Generating API References">
Expand Down Expand Up @@ -165,4 +170,7 @@ Mintlify supports an array of advanced features like API reference docs, analyti

### All Done!

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).
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).