Skip to content

Latest commit

 

History

History
31 lines (22 loc) · 1.44 KB

edit.mdx

File metadata and controls

31 lines (22 loc) · 1.44 KB
Raw
title description
Editing your docs
The editing guide on setting up ready-to-share docs

Hero Image

For anything else, join our Slack Community or email us.

Get inspiration from other Mintlify users on our showcase.

We offer free migrations with our startup plan. Request a migration over [email](mailto:josh@mintlify.com).

Edit Locally (recommended for developers)

1. [Install git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).
2. Clone your deployment repo with the command `git clone <your-repo>`. You may need to set up [SSH keys](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) if you haven't before.
3. Open the repo in your IDE of choice.
4. Preview changes with our [Mintlify CLI](/development). Install with `npm i -g mintlify`

Edit Online

There are two ways to edit your repo online.

  • Find the edit button on the file you'd like to edit. This will open an in-line web editor in Github.
  • Open your git repo in Github's github.dev online IDE. Take the URL of your repo and replace github.com with github.dev. (e.g. github.dev/mintlify/docs instead of github.com/mintlify/docs)