grmdocs
GuidesAPI reference
Getting started

Quickstart

Start building awesome documentation in minutes

Get started in three steps

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

Step 1: Set up your local environment

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 MinimalDocs CLI: npm i -g minimaldocs
  2. Navigate to your docs directory and run: minimaldocs dev
  3. Open http://localhost:3000 to see your docs live!
Your preview updates automatically as you edit files.

Step 2: Deploy your changes

Connect your GitHub repository from your dashboard.

MinimalDocs automatically deploys your changes to your docs site whenever you push to your main branch.

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? See our full documentation or email us at hello@minimaldocs.com.