Skip to content

Commit 287b00b

Browse files
committed
Documentation edits made through Mintlify web editor
1 parent 48d3c2f commit 287b00b

File tree

2 files changed

+43
-41
lines changed

2 files changed

+43
-41
lines changed

development.mdx

Lines changed: 41 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,29 @@
11
---
2-
title: 'Local Development'
3-
description: 'Preview changes locally to update your docs'
2+
title: "Local Development"
3+
description: "Preview changes locally to update your docs"
44
---
55

66
<Info>
7-
8-
**Prerequisite**: Please install Node.js (version 19 or higher) before proceeding.
9-
7+
**Prerequisite**: Please install Node.js (version 19 or higher) before proceeding.
108
</Info>
119

1210
**Step 1**: Install the Mintlify CLI:
1311

1412
<CodeGroup>
1513

16-
```bash npm
17-
npm i -g mintlify
18-
```
14+
```bash npm
15+
npm i -g mintlify
16+
```
17+
1918

20-
```bash yarn
21-
yarn global add mintlify
22-
```
19+
```bash yarn
20+
yarn global add mintlify
21+
```
2322

24-
```bash pnpm
25-
pnpm add -g mintlify
26-
```
23+
24+
```bash pnpm
25+
pnpm add -g mintlify
26+
```
2727

2828
</CodeGroup>
2929

@@ -36,22 +36,25 @@ mintlify dev
3636
Alternatively, if you do not want to install the CLI globally you can use a run script available:
3737

3838
<CodeGroup>
39-
```bash npm
40-
npx mintlify dev
41-
```
4239

43-
```bash yarn
44-
yarn dlx mintlify dev
45-
```
40+
```bash npm
41+
npx mintlify dev
42+
```
43+
44+
45+
```bash yarn
46+
yarn dlx mintlify dev
47+
```
4648

47-
```bash pnpm
48-
pnpm dlx mintlify dev
49-
```
49+
50+
```bash pnpm
51+
pnpm dlx mintlify dev
52+
```
5053

5154
</CodeGroup>
5255

5356
<Warning>
54-
Yarn's "dlx" run script requires yarn version >2. See [here](https://yarnpkg.com/cli/dlx) for more information.
57+
Yarn's "dlx" run script requires yarn version \>2. See [here](https://yarnpkg.com/cli/dlx) for more information.
5558
</Warning>
5659

5760
A local preview of your documentation will be available at `http://localhost:3000`.
@@ -76,17 +79,19 @@ Please note that each CLI release is associated with a specific version of Mintl
7679

7780
<CodeGroup>
7881

79-
```bash npm
80-
npm i -g mintlify@latest
81-
```
82+
```bash npm
83+
npm i -g mintlify@latest
84+
```
85+
86+
87+
```bash yarn
88+
yarn global upgrade mintlify
89+
```
8290

83-
```bash yarn
84-
yarn global upgrade mintlify
85-
```
8691

87-
```bash pnpm
88-
pnpm up --global mintlify
89-
```
92+
```bash pnpm
93+
pnpm up --global mintlify
94+
```
9095

9196
</CodeGroup>
9297

@@ -117,15 +122,13 @@ We suggest using extensions on your IDE to recognize and format MDX. If you're a
117122

118123
<AccordionGroup>
119124
<Accordion title='Error: Could not load the "sharp" module using the darwin-arm64 runtime'>
120-
121125
This may be due to an outdated version of node. Try the following:
126+
122127
1. Remove the currently-installed version of mintlify: `npm remove -g mintlify`
123128
2. Upgrade to Node v19 or higher.
124129
3. Reinstall mintlify: `npm install -g mintlify`
125130
</Accordion>
126-
127131
<Accordion title="Issue: Encountering an unknown error">
128-
129-
Solution: Go to the root of your device and delete the \~/.mintlify folder. Afterwards, run `mintlify dev` again.
132+
Solution: Go to the root of your device and delete the ~/.mintlify folder. Afterwards, run `mintlify dev` again.
130133
</Accordion>
131-
</AccordionGroup>
134+
</AccordionGroup>

table.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,15 @@ description: "Display an arrangement of data in rows and columns"
99
| Age | Reported age |
1010
| Joined | Whether the user joined the community |
1111

12-
## This is a Table
13-
1412
### Creating a table
1513

1614
<Tip>
1715
The Table component follows the official [markdown syntax](https://www.markdownguide.org/extended-syntax/#tables).
1816
</Tip>
1917

2018
<span className="hover:bg-cyan-500">
21-
To add a table
19+
To add a table
20+
2221
</span>
2322

2423
, 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.

0 commit comments

Comments
 (0)