Skip to main content

​
Get started in three steps

Get your documentation site running locally and make your first customization.

​
Step 1: Set up your local environment

Clone the Lantern documentation repository from GitHub:
git clone https://github.com/Bistretech/lanterndocs.git
cd lanterndocs
Follow the Cloning a repository guide for more details.
  1. Install the Mintlify CLI: npm i -g mint
  2. Navigate to your docs directory and run: mint dev
  3. Open http://localhost:3000 to see your docs live!
Your preview updates automatically as you edit files.

​
Step 2: Deploy your changes

Changes pushed to the main branch are automatically deployed.
git add .
git commit -m "Update documentation"
git push origin main
For a first change, let’s update the name and colors of your docs site.
  1. Open docs.json in your editor.
  2. Change the "name" field to your project name.
  3. Update the "colors" to match your brand.
  4. Save and see your changes instantly at http://localhost:3000.
Try changing the primary color to see an immediate difference!

​
Step 3: Go live

  1. Commit and push your changes.
  2. Your docs will update and be live in moments!

​
Next steps

Now that you have your docs running, explore these key features:

Write Content

Learn MDX syntax and start writing your documentation.

Customize style

Make your docs match your brand perfectly.

Add code examples

Include syntax-highlighted code blocks.

API documentation

Auto-generate API docs from OpenAPI specs.
Need help? Visit asklantern.com or contact our support team at support@asklantern.com.
⌘I