https://github.com/esimkowitz/mintlify-docs

https://github.com/esimkowitz/mintlify-docs

Last synced: 4 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/esimkowitz/mintlify-docs
• Owner: esimkowitz
• Created: 2024-04-22T20:29:11.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-04-22T20:29:13.000Z (7 months ago)
• Last Synced: 2024-04-22T21:39:28.750Z (7 months ago)
• Language: MDX
• Size: 149 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Mintlify Starter Kit

Click on `Use this template` to copy the Mintlify starter kit. The starter kit contains examples including

- Guide pages

- Navigation

- Customizations

- API Reference pages

- Use of popular components

### Development

Install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the documentation changes locally. To install, use the following command

```

npm i -g mintlify

```

Run the following command at the root of your documentation (where mint.json is)

```

mintlify dev

```

### Publishing Changes

Install our Github App to autopropagate changes from youre repo to your deployment. Changes will be deployed to production automatically after pushing to the default branch. Find the link to install on your dashboard. 

#### Troubleshooting

- Mintlify dev isn't running - Run `mintlify install` it'll re-install dependencies.

- Page loads as a 404 - Make sure you are running in a folder with `mint.json`