Cool_Tools/upscayl
1
0
Fork 0
mirror of https://github.com/upscayl/upscayl.git synced 2024-09-23 19:08:25 +02:00
Code Releases Wiki Activity
75d0bee853
upscayl/docs
History
Nayam Amarshe 75d0bee853 Add documentation
2024-01-31 15:48:49 +05:30
..
api-reference Add documentation 2024-01-31 15:48:49 +05:30
essentials Add documentation 2024-01-31 15:48:49 +05:30
images Add documentation 2024-01-31 15:48:49 +05:30
logo Add documentation 2024-01-31 15:48:49 +05:30
snippets Add documentation 2024-01-31 15:48:49 +05:30
development.mdx Add documentation 2024-01-31 15:48:49 +05:30
favicon.svg Add documentation 2024-01-31 15:48:49 +05:30
introduction.mdx Add documentation 2024-01-31 15:48:49 +05:30
mint.json Add documentation 2024-01-31 15:48:49 +05:30
quickstart.mdx Add documentation 2024-01-31 15:48:49 +05:30
README.md Add documentation 2024-01-31 15:48:49 +05:30

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