mirror of https://github.com/upscayl/upscayl.git synced 2024-11-23 23:21:05 +01:00

History

Nayam Amarshe 07915de1ca Update docs title		2024-04-25 01:56:34 +05:30
..
images	Add documentation	2024-01-31 15:48:49 +05:30
logo	Update docs	2024-04-25 01:52:50 +05:30
Compatibility-List.md	crudely import docs from wiki	2024-02-01 18:42:35 -05:00
development.mdx	Add documentation	2024-01-31 15:48:49 +05:30
favicon.svg	crudely import docs from wiki	2024-02-01 18:42:35 -05:00
Guide.md	Update docs	2024-04-25 01:52:50 +05:30
Home.md	crudely import docs from wiki	2024-02-01 18:42:35 -05:00
How-to-ask-for-help.md	crudely import docs from wiki	2024-02-01 18:42:35 -05:00
introduction.mdx	Update docs	2024-04-25 01:52:50 +05:30
mint.json	Update docs title	2024-04-25 01:56:34 +05:30
Misc.md	crudely import docs from wiki	2024-02-01 18:42:35 -05:00
Model-Conversion-Guide.md	Update docs	2024-04-25 01:52:50 +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
Troubleshooting.md	crudely import docs from wiki	2024-02-01 18:42:35 -05: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 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