Skip to main content

​
Get started in three steps

Use this guide to run the docs locally, make a change, and publish it.

​
Step 1: Set up your local environment

  1. Install the Mintlify CLI:
  1. From the repository root (where docs.json lives), start the preview server:
  1. Open http://localhost:3000.
Your preview updates automatically when you save file changes.

​
Step 2: Make your first update

  1. Open docs.json.
  2. Update the name field for your project.
  3. Adjust the colors values to match your brand.
  4. Save and verify the changes in your local preview.

​
Step 3: Publish

  1. Commit your changes.
  2. Push to your default branch.
  3. Confirm the site deploy completes.

​
Next pages

Hytale server guide

Add and maintain your Hytale server listing instructions.

Repository overview

Review your repo settings, branches, and pull requests.
Need Mintlify reference docs? See mintlify.com/docs.