Skip to main content

Documentation Index

Fetch the complete documentation index at: https://help-center-starter-replace-template-content.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

This guide gets you from zero to a live Mintlify docs site with a deployed URL and your first published change.

​
Before you begin

  • A GitHub or GitLab account (either will work)
  • A repository for your documentation, or permission to create one

​
Steps

  1. Sign up — Go to mintlify.com/start and create your account. You can sign up with GitHub for a faster setup.
  2. Connect your repository — Select the GitHub or GitLab repo that contains your docs. Mintlify installs a GitHub App that watches for pushes and triggers deployments automatically.
  3. Wait for the first deploy — The initial build takes about a minute. When it’s done, your site is live at a *.mintlify.app URL shown in your dashboard.
  4. Make your first edit — Choose your path:
    • Web editor — Click Edit in the dashboard. Edit pages in the browser and click Publish when ready.
    • CLI — Run npm i -g mintlify && mintlify dev to preview locally, then push to Git to deploy.
  5. Share a preview — Open a pull request. Mintlify automatically builds a preview deployment and posts the URL as a status check on the PR.

​
Next steps