DOCSEARCHbyAlgolia
Submit Docs

Mintlify Starter Kit Documentation

repository·main·Indexed 23 days ago

https://github.com/mintlify/starter

A template for developers to quickly deploy and customize documentation, featuring pre-configured guide pages, navigation, API references, and components. Includes instructions for using the Mintlify CLI for local development, configuring site settings via docs.json, and deploying via the Mintlify GitHub app.

Tokens
506
Snippets
4
Records
6
Agent score
34%

What's inside Mintlify Starter Kit

  1. Publish changes to production

    main
    To automatically deploy changes from your repository to your live documentation, install the Mintlify GitHub app from your dashboard. Once configured, any changes pushed to your default branch will be automatically deployed to production.

  2. Get started with the Mintlify Starter Kit

    main

    To begin using the Mintlify Starter Kit, follow these steps to install, configure, and run the project locally.

    1. Install

    Install the necessary package using npm:

    npm install your-package

    2. Configure

    Initialize the project configuration using the CLI:

    your-cli init

    3. Run it

    Start the development server to see the project in action:

    your-cli start
    npm install your-package
your-cli init
your-cli start

  3. Install and use the Mintlify CLI for local development

    main

    The Mintlify CLI allows you to preview your documentation changes locally.

    1. Install the CLI globally via npm:
    npm i -g mint
    1. Navigate to the root of your documentation folder (where docs.json is located) and start the development server:
    mint dev
    1. View your local preview at http://localhost:3000.
    npm i -g mint
mint dev

  4. Customize your site using docs.json

    main
    To personalize your Mintlify site, you should start by editing your docs.json file. This file is used to configure core site settings such as your site name, branding, and navigation structure.

  5. Set up AI-assisted writing for Mintlify

    main

    To enable your AI coding tools (such as Claude Code, Cursor, or Windsurf) to understand Mintlify's component references, writing standards, and workflows, install the Mintlify documentation skill using the following command:

    npx skills add https://mintlify.com/docs

  6. Troubleshoot Mintlify development environment

    main

    If you encounter issues with your local development environment, try the following:

    • Dev environment isn't running: Run mint update to ensure you are using the most recent version of the CLI.
    • Page loads as a 404: Verify that you are running the command from a folder that contains a valid docs.json file.
    mint update