Skip to main content

​
Step 1: Set up your desktop device

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: Set up your Android device

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 3: Start syncing

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

​
Next steps

This is enough for a stable syncing setup between 2 or more devices with absolute privacy. However, if you want to go a step further or are willing to take on a challenge, you might want to self host the API server and build your client apps from scratch.

Self Hosting the Server

Self Hosting Board’s API server from scratch and setting up the client apps to use the custom API server.

Building the macOS app

Compiling and building a binary build for the macOS client app from source

Building the Windows app

Compiling and building a binary build for the Windows client app from source

Building the Android app

Compiling and building a binary build for the Android client app from source