​
Get started in three steps

Get your Cleverschool site running in minutes.

​
Step 1: Register Your School

During the onboarding process, you created a GitHub repository with your docs content if you didn’t already have one. You can find a link to this repository in your dashboard.To clone the repository locally so that you can make and preview changes to your docs, follow the Cloning a repository guide in the GitHub docs.
  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: Validate your email

Install the Mintlify GitHub app from your dashboard.Our GitHub app automatically deploys your changes to your docs site, so you don’t need to manage deployments yourself.
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 4: Invite other staff to join you

  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

Feature 1

Customize style

Feature 2

Add code examples

Feature 3

API documentation

Feature 4
Need help? See our full documentation or join our community.