Skip to content
Closed
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
4 changes: 3 additions & 1 deletion code.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,15 @@ icon: 'code'

### Inline Code

* test 1

To denote a `word` or `phrase` as code, enclose it in backticks (\`).

```
To denote a `word` or `phrase` as code, enclose it in backticks (`).
```


![](/yellow-bg.png)

### Code Block

Expand Down
23 changes: 7 additions & 16 deletions development.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,12 @@
---

<Info>

**Prerequisite**: Please install Node.js (version 19 or higher) before proceeding.

**Prerequisite**: Please install Node.js (version 19 or higher) before proceeding.
</Info>

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

<CodeGroup>

```bash npm
npm i -g mintlify
```
Expand All @@ -24,7 +21,6 @@
```bash pnpm
pnpm add -g mintlify
```

</CodeGroup>

**Step 2**: Navigate to the docs directory (where the `docs.json` file is located) and execute the following command:
Expand All @@ -41,13 +37,12 @@
```

```bash yarn
yarn dlx mintlify dev

Check warning on line 40 in development.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

development.mdx#L40

Did you really mean 'npx'?
```

```bash pnpm
pnpm dlx mintlify dev
```

</CodeGroup>

<Warning>
Expand All @@ -56,7 +51,7 @@

A local preview of your documentation will be available at `http://localhost:3000`.

### Custom Ports

Check warning on line 54 in development.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

development.mdx#L54

Did you really mean 'dlx'?

By default, Mintlify uses port 3000. You can customize the port using the `--port` flag. To run Mintlify on port 3333, for instance, use this command:

Expand All @@ -75,7 +70,6 @@
Please note that each CLI release is associated with a specific version of Mintlify. If your local website doesn't align with the production version, please update the CLI:

<CodeGroup>

```bash npm
npm i -g mintlify@latest
```
Expand All @@ -87,7 +81,6 @@
```bash pnpm
pnpm up --global mintlify
```

</CodeGroup>

## Validating Links
Expand All @@ -103,10 +96,7 @@
If the deployment is successful, you should see the following:

<Frame>
<img
className="rounded-md"
src="https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/checks-passed.png"
/>
<img className="rounded-md" src="https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/checks-passed.png" />
</Frame>

## Code Formatting
Expand All @@ -116,16 +106,17 @@
## Troubleshooting

<AccordionGroup>
<Accordion title='Error: Could not load the "sharp" module using the darwin-arm64 runtime'>

<Accordion title="Error: Could not load the &#x22;sharp&#x22; module using the darwin-arm64 runtime">
This may be due to an outdated version of node. Try the following:

1. Remove the currently-installed version of mintlify: `npm remove -g mintlify`

2. Upgrade to Node v19 or higher.

3. Reinstall mintlify: `npm install -g mintlify`
</Accordion>

<Accordion title="Issue: Encountering an unknown error">

Solution: Go to the root of your device and delete the \~/.mintlify folder. Afterwards, run `mintlify dev` again.
</Accordion>
</AccordionGroup>
</AccordionGroup>
Binary file added yellow-bg.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.