Skip to content

Commit 30e0e9a

Browse files
authored
Add broken links CI (#238)
* Add broken links CI * fix all broken links
1 parent 8fb6b46 commit 30e0e9a

File tree

4 files changed

+41
-72
lines changed

4 files changed

+41
-72
lines changed

.github/workflows/check-links.yml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: Check links
2+
3+
on: pull_request
4+
5+
jobs:
6+
check-links:
7+
name: Check links
8+
runs-on: ubuntu-latest
9+
steps:
10+
- uses: actions/checkout@v4
11+
- name: Set up Node
12+
uses: actions/setup-node@v4
13+
with:
14+
node-version: "latest"
15+
- name: Install Mintlify CLI
16+
run: npm i -g mintlify
17+
- name: Run broken link checker
18+
run: mintlify broken-links

content/components/accordions.mdx

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,23 @@
11
---
2-
title: 'Accordions'
3-
description: 'A dropdown component for toggling content'
4-
icon: 'square-caret-down'
2+
title: "Accordions"
3+
description: "A dropdown component for toggling content"
4+
icon: "square-caret-down"
55
---
66

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

1313
<RequestExample>
1414

15-
```jsx Accordion Example
16-
<Accordion title="I am an Accordion.">
17-
You can put any content in here.
18-
</Accordion>
19-
```
15+
```jsx Accordion Example
16+
<Accordion title="I am an Accordion.">
17+
You can put any content in here.
18+
</Accordion>
19+
```
20+
2021
</RequestExample>
2122

2223
## Props

embed.mdx

Lines changed: 0 additions & 58 deletions
This file was deleted.

quickstart.mdx

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,14 @@ icon: "rocket"
1717

1818
## Getting Started
1919

20-
Welcome to the Mintlify documentation guide. Follow the instructions below to learn how to deploy, update and supercharge your documentation with Mintlify.
20+
Welcome to the Mintlify documentation guide. Follow the instructions below to
21+
learn how to deploy, update and supercharge your documentation with Mintlify.
2122

2223
### 1. Deploying Your Docs Repository
2324

24-
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.
25+
Mintlify docs are rendered from MDX files and configurations defined in our
26+
[starter template](https://github.com/mintlify/starter). We use Github to
27+
integrate your docs with your code, and make source control effortless.
2528

2629
<AccordionGroup>
2730
<Accordion icon="github" title="Creating Your Documentation Repository">
@@ -48,7 +51,8 @@ Mintlify docs are rendered from MDX files and configurations defined in our [sta
4851

4952
### 2. Updating Your Docs
5053

51-
Mintlify enables you to easily customize the style, structure, and content of your docs.
54+
Mintlify enables you to easily customize the style, structure, and content of
55+
your docs.
5256

5357
<Note>
5458
We provide a white-glove migration service as part of our Enterprise plan.
@@ -125,7 +129,8 @@ Mintlify enables you to easily customize the style, structure, and content of yo
125129

126130
### 3. Supercharging Your Docs
127131

128-
Mintlify supports an array of advanced features like API reference docs, analytics, and versioning to accommodate any of your documentation needs.
132+
Mintlify supports an array of advanced features like API reference docs,
133+
analytics, and versioning to accommodate any of your documentation needs.
129134

130135
<AccordionGroup>
131136
<Accordion icon="code-branch" title="Generating API References">
@@ -167,4 +172,7 @@ Mintlify supports an array of advanced features like API reference docs, analyti
167172

168173
### All Done!
169174

170-
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 [[email protected]](mailto:[email protected]).
175+
Congrats! You've set up your Mintlify Docs and it's looking amazing! Need
176+
support or want to give some feedback? You can join our
177+
[community](https://mintlify.com/community) or drop us an email at
178+

0 commit comments

Comments
 (0)