thundergear-io/docs
1
0
Fork 0
mirror of https://github.com/thundergear-io/docs.git synced 2026-07-25 21:19:16 +00:00
Code Issues Projects Packages Wiki Activity
No description
1 commit 1 branch 0 tags 230 KiB
  • MDX 100%
Find a file
Exact
Chromico Rek 0211c8506b
 Initial commit
2024-12-25 17:35:00 +04:00
api-reference Initial commit 2024-12-25 17:35:00 +04:00
essentials Initial commit 2024-12-25 17:35:00 +04:00
images Initial commit 2024-12-25 17:35:00 +04:00
logo Initial commit 2024-12-25 17:35:00 +04:00
snippets Initial commit 2024-12-25 17:35:00 +04:00
development.mdx Initial commit 2024-12-25 17:35:00 +04:00
favicon.svg Initial commit 2024-12-25 17:35:00 +04:00
introduction.mdx Initial commit 2024-12-25 17:35:00 +04:00
mint.json Initial commit 2024-12-25 17:35:00 +04:00
quickstart.mdx Initial commit 2024-12-25 17:35:00 +04:00
README.md Initial commit 2024-12-25 17:35:00 +04: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 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.

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