Skip to main content
This section is for working on this documentation site (Mintlify). To develop or use the SDK or sdk-react packages themselves, see the SDK and sdk-react tabs and your monorepo scripts.
Prerequisites:
  • Node.js 18+ (19+ recommended for Mintlify CLI)
  • This docs repo with a docs.json at the root of the docs folder

​
Run the docs locally

1

Install the Mintlify CLI

npm i -g mint
2

Start the preview server

From the docs directory (where docs.json lives), run:
mint dev
Open http://localhost:3000 to view the site. The preview reloads when you edit MDX or docs.json.

​
Default theme

The site is configured to use dark mode by default. Users can still switch to light mode via the theme toggle if you leave it enabled in docs.json.

​
Custom port

To use a different port: 
mint dev --port 3333
If the chosen port is in use, Mintlify will try the next available port. Check for broken links in the documentation: 
mint broken-links

​
Updating the CLI

To align with the latest Mintlify behavior: 
npm update -g mint

​
Editing content

  • Navigation: Edit docs.json → navigation.tabs. Each tab (Introduction, SDK, sdk-react, sdk-react-ui, API reference) has its own groups and pages.
  • Pages: Edit or add .mdx files under the paths referenced in docs.json (e.g. sdk/overview.mdx, index.mdx).
  • Code blocks: Use fenced code blocks with a language tag for syntax highlighting.
For MDX formatting, a Prettier or MDX extension in your editor is helpful.

​
Troubleshooting

Try upgrading Node to v19+ and reinstalling the CLI: npm remove -g mint then npm i -g mint.
Update the Mintlify CLI: npm update -g mint. Each CLI version targets a specific Mintlify release.
Remove the Mintlify cache folder ~/.mintlify and run mint dev again.

​
SDK and package development

To build or test the @alphscan/sdk, @alphscan/sdk-react, or @alphscan/sdk-react-ui packages (e.g. in a monorepo), use that repo’s scripts (e.g. pnpm run build, pnpm run test). The SDK, sdk-react, and sdk-react-ui tabs in this docs site describe the public API and usage.