Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mintlify Docs Edits #364

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Mintlify Docs Edits #364

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
44 changes: 23 additions & 21 deletions development.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,27 +4,33 @@ description: 'Preview changes locally to update your docs'
---

<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 Mintlify:

<CodeGroup>

```bash npm
npm i -g mintlify
```

```bash yarn
yarn global add mintlify
```

```bash yarn
yarn global add mintlify
```
</CodeGroup>

**Step 2**: Navigate to the docs directory (where the `mint.json` file is located) and execute the following command:



<Info>
Callout Content

test chargebee
</Info>



```bash
mintlify dev
```
Expand All @@ -50,15 +56,13 @@ Port 3000 is already in use. Trying 3001 instead.
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
```

```bash yarn
yarn global upgrade mintlify
```

```bash yarn
yarn global upgrade mintlify
```
</CodeGroup>

## Validating Links
Expand All @@ -74,10 +78,7 @@ mintlify broken-links
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 @@ -87,16 +88,17 @@ We suggest using extensions on your IDE to recognize and format MDX. If you're a
## 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>