Skip to content

docs: Mintlify CLI, Node LTS note, and config filename clarifications #613

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

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

docs: Mintlify CLI, Node LTS note, and config filename clarifications #613

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
24 changes: 13 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,37 +29,39 @@ Base Docs are community-managed. We welcome and encourage contributions from eve

## Local development

Prerequisite: Node.js v19+.
Prerequisite: Node.js 18.17+ (LTS recommended). Also tested with Node 20 and 22.

1. Clone the repository.
2. Install the Mint CLI to preview documentation changes locally:
2. Install the Mintlify CLI to preview documentation changes locally:

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

3. Preview locally (run from the `docs/` directory where `docs.json` lives):
3. Preview locally (run from the `docs/` directory where your Mintlify config (`docs.json` or `mint.json`) lives):

```bash
cd docs
mint dev
npx mintlify dev
```

Alternatively, without a global install:
Alternatively, without a global install (recommended to avoid global dependencies):

```bash
npx mint dev
npx mintlify dev
```

### Troubleshooting

- Ensure Node.js v19+ is installed and that you run `mint dev` from the directory containing `docs.json` (usually `docs/`).
- Local preview differs from production: run `mint update` to update the CLI.
- Ensure Node.js 18.17+ is installed and that you run `npx mintlify dev` from the directory containing your Mintlify config (`docs.json` or `mint.json`) (usually `docs/`).
- If local preview differs from production, run the latest CLI:
- `npx mintlify@latest dev` (no global install), or
- `npm i -g mintlify@latest` (to update a global install)

## How to contribute

1. **Fork and branch**: Fork `base/docs` and create a descriptive branch for your change.
2. **Edit content in `docs/`**: Follow the structure and style guidelines below. Preview locally with the Mint CLI.
2. **Edit content in `docs/`**: Follow the structure and style guidelines below. Preview locally with the Mintlify CLI.
3. **Open a pull request**: Provide a clear summary and links to related pages. The docs team and community will review.

> Tip: Prefer small, focused PRs. Link related guides and references directly in your content.
Expand Down Expand Up @@ -163,4 +165,4 @@ The core team will review opened PRs. The SLA is 2 weeks, generally on a first-c

## Storybook for UI components

See `storybook/README.md` for details on local Storybook and component docs.
See `storybook/README.md` for details on local Storybook and component docs.