History

Nevo David aa612447e8 feat: change docs		2024-09-01 23:30:31 +07:00
..
_snippets	feat: swagger	2024-03-11 20:16:37 +07:00
api-reference	feat: higher version	2024-03-11 23:21:53 +07:00
essentials	feat: swagger	2024-03-11 20:16:37 +07:00
images	feat: ignore api key	2024-03-19 11:20:09 +07:00
logo	feat: change docs	2024-09-01 23:30:31 +07:00
providers	feat: ignore api key	2024-03-19 11:20:09 +07:00
use	feat: added dots	2024-03-19 14:57:03 +07:00
README.md	feat: swagger	2024-03-11 20:16:37 +07:00
emails.mdx	feat: documentation change	2024-03-17 15:59:54 +07:00
favicon.ico	feat: fix dates, attachments	2024-03-13 23:05:46 +07:00
favicon.png	feat: fix dates, attachments	2024-03-13 23:05:46 +07:00
github.mdx	feat: documentation change	2024-03-17 15:59:54 +07:00
howitworks.mdx	feat: documentation change	2024-03-17 15:59:54 +07:00
introduction.mdx	feat: documentation change	2024-03-17 15:59:54 +07:00
mint.json	feat: change docs	2024-09-01 23:30:31 +07:00
openapi.json	feat: analytics controller	2024-03-13 16:53:06 +07:00
project.json	feat: remove broken redis	2024-03-12 20:23:26 +07:00
quickstart.mdx	docs: update quickstart.mdx	2024-09-02 00:39:47 +09:00

README.md

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 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