Skip to content

Commit 088cd97

Browse files
committed
starter kit
1 parent 4ec6818 commit 088cd97

File tree

249 files changed

+1171
-9886
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

249 files changed

+1171
-9886
lines changed

.gitignore

Lines changed: 0 additions & 5 deletions
This file was deleted.

README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Mintlify Starter Kit
2+
3+
Click on `Use this template` to copy the Mintlify starter kit. The starter kit contains examples including
4+
5+
- Guide pages
6+
- Navigation
7+
- Customizations
8+
- API Reference pages
9+
- Use of popular components
10+
11+
### Development
12+
13+
Install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the documentation changes locally. To install, use the following command
14+
15+
```
16+
npm i -g mintlify
17+
```
18+
19+
Run the following command at the root of your documentation (where docs.json is)
20+
21+
```
22+
mintlify dev
23+
```
24+
25+
### Publishing Changes
26+
27+
Install our Github App to auto propagate changes from your 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.
28+
29+
#### Troubleshooting
30+
31+
- Mintlify dev isn't running - Run `mintlify install` it'll re-install dependencies.
32+
- Page loads as a 404 - Make sure you are running in a folder with `docs.json`

advanced/dashboard/permissions.mdx

Lines changed: 0 additions & 16 deletions
This file was deleted.

advanced/dashboard/sso.mdx

Lines changed: 0 additions & 94 deletions
This file was deleted.

advanced/mcp/generate.mdx

Lines changed: 0 additions & 39 deletions
This file was deleted.

advanced/mcp/quickstart.mdx

Lines changed: 0 additions & 95 deletions
This file was deleted.

advanced/rest-api/chat/create-topic.mdx

Lines changed: 0 additions & 3 deletions
This file was deleted.

advanced/rest-api/chat/generate-message.mdx

Lines changed: 0 additions & 3 deletions
This file was deleted.

advanced/rest-api/overview.mdx

Lines changed: 0 additions & 42 deletions
This file was deleted.

advanced/rest-api/update/status.mdx

Lines changed: 0 additions & 3 deletions
This file was deleted.

0 commit comments

Comments
 (0)