Skip to content

Commit

Permalink
chore: Readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
tonyxiao committed Dec 2, 2023
1 parent 7ec7ee3 commit 3f95d0d
Showing 1 changed file with 8 additions and 19 deletions.
27 changes: 8 additions & 19 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,21 @@
# 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
Currently hosted at https://opensdks.mintlify.app/, will migrate to https://docs.opensdks.org later

### 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
```bash
pnpm 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.
```bash
git push
```
Changes will be deployed to production automatically after pushing to the main branch.

#### Troubleshooting

- Mintlify dev isn't running - Run `mintlify install` it'll re-install dependencies.
- Mintlify dev isn't running - Run `pnpm mintlify install` it'll re-install dependencies.
- Page loads as a 404 - Make sure you are running in a folder with `mint.json`

0 comments on commit 3f95d0d

Please sign in to comment.