Skip to content
This repository has been archived by the owner on Mar 7, 2024. It is now read-only.

Latest commit

 

History

History
67 lines (52 loc) · 2.73 KB

introduction.mdx

File metadata and controls

67 lines (52 loc) · 2.73 KB
title description
Introduction
Welcome to the Mintlify Starter Kit
Update the content in main branch of your docs repo, and your documentation page will automatically be updated. It's that simple!

Getting Started

Select from the following guides to learn more about how Mintlify can best suit your documentation.

Run on your computer to see changes locally Customizing the theme, branding, and other global configurations Setting the title and metadata for navigation and SEO Introduction on how to add and edit content See more in the resources page

Customization Checklist

Learn more about you can fully customize the starter template for your own documentation

Update the `name` property in `mint.json` to the name of your company or product Branding mostly happens in the `mint.json` file. You can learn more about all available [configuration properties](https://mintlify.com/docs/settings/global).
#### Update the logo

Update `logo` folder with the light and dark version of your logo (can be svg or png).
<Note>Make sure that the path matches the values set in `logo` of `mint.json`</Note>

#### Customize the colors

Populate the `colors` object with colors that match your brand

#### Update the favicon

Change the `favicon.png` with an image of the favicon

#### Update footer social icons

Update `footerSocials` with the right `[platform]: [url]` key-value pair
Update the `anchors` array in `mint.json` with the links that you want to emphasize Either update the pages in `api-reference` or remove it entirely If removing the API Reference, make sure to also remove it from the `anchors` and `navigation` from `mint.json` Update the `topbarCtaButton` and `topbarLinks` properties in `mint.json` to the links that matter most The `topbarCtaButton` will receive the most number of clicks