Skip to content
Open
Show file tree
Hide file tree
Changes from 1 commit
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
14 changes: 7 additions & 7 deletions CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,22 +11,22 @@ This is a Mintlify documentation site that creates a modern documentation websit
### Development Setup
```bash
# Install Mintlify CLI globally (required)
npm i -g mintlify
npm i -g mint

# Start development server (default port 3000)
mintlify dev
mint dev

# Start on custom port
mintlify dev --port 3333
mint dev --port 3333

# Validate all reference links
mintlify broken-links
mint broken-links

# Re-install dependencies if issues occur
mintlify install
rm -rf ~/.mintlify && mint dev
```

**Note:** Requires Node.js version 19 or higher.
**Note:** Requires Node.js v20.17.0 or higher.

## Architecture & Structure

Expand Down Expand Up @@ -57,4 +57,4 @@ mintlify install
2. Navigation structure is defined in `docs.json` under the `tabs` property.
3. The site supports both light and dark modes with corresponding logo variants.
4. Deployment happens automatically via Mintlify's GitHub App when pushing to the default branch.
5. The API Reference section uses OpenAPI specification for automatic documentation generation.
5. The API Reference section uses OpenAPI specification for automatic documentation generation.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ Official documentation for [Ghost](https://github.com/tryghost/ghost) - located
Install Mintlify CLI to preview docs changes locally:

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

Start dev server with:

```
mintlify dev
mint dev
```

---
Expand Down