https://github.com/lukasjhan/docs

https://github.com/lukasjhan/docs

Last synced: 12 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/lukasjhan/docs
• Owner: lukasjhan
• Created: 2023-05-15T09:04:53.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-10-13T00:14:24.000Z (about 1 year ago)
• Last Synced: 2024-10-24T08:52:29.292Z (2 months ago)
• Language: MDX
• Size: 6.83 MB
• 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

Changes will be deployed to production automatically after pushing to the default branch.

You can also preview changes using PRs, which generates a preview link of the docs.

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