Skip to content

Latest commit

 

History

History
58 lines (51 loc) · 2.81 KB

introduction.mdx

File metadata and controls

58 lines (51 loc) · 2.81 KB
Raw
title description
Welcome to your new docs!
Now it's your time to shine. Keep reading to learn more on how to make your docs beautiful and powerful.

Getting Started

💻 Set up autodeploys

  • Install our Github Bot to setup autodeploying your docs. You should have received an email with a link. Didn't get an email? Contact us.
  • Download our Mintlify CLI to preview changes locally.

😎 Make it yours

  1. Change name in the mint.json file to your company or product's name.
  2. Update logo folder with the light and dark version of your logo (can be svg or png).
  3. Populate the colors object with colors that match your brand
  4. Change the favicon.png with an image of the favicon
  5. Update footerSocials with the right [platform]: [url] key-value pair

✍️ Add content

Need inspiration? Check out some of our customers' docs . Add anything from images and new pages on your docs to creating your own MDX components. Check out the components we have built out of the box here.

Have existing docs and want support migrating? Contact us.

Quick links

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

Advanced Topics

Learn more about how to take your documentation to the next level

Get the documentation hosted at your custom domain Advanced components built for specific communication mediums Add an API playground into your documentation Learn how users are interacting with your documentation