@@ -9,10 +9,14 @@ This quickstart guide shows you how to set up and deploy your documentation site
99After completing this guide, you will have a live documentation site ready to customize and expand.
1010
1111<Info >
12+ ** Prerequisites** : Before you begin, [ create an account] ( https://mintlify.com/start ) and complete onboarding.
13+ </Info >
1214
13- ** Prerequisites ** : Before you begin, [ create an account ] ( https://mintlify.com/start ) and complete onboarding.
15+ this is just to show jack how this works
1416
15- </Info >
17+ <Card title = " New Card" icon = " sparkles" >
18+
19+ </Card >
1620
1721## Getting started
1822
@@ -25,8 +29,17 @@ https://<your-project-name>.mintlify.app
2529Find your URL on the Overview page of your [ dashboard] ( https://dashboard.mintlify.com/ ) .
2630
2731<Frame >
28- <img src = " /images/quickstart/mintlify-domain-light.png" alt = " Mintlify Domain" className = " block dark:hidden" />
29- <img src = " /images/quickstart/mintlify-domain-dark.png" alt = " Mintlify Domain" className = " hidden dark:block" />
32+ <img
33+ src = " /images/quickstart/mintlify-domain-light.png"
34+ alt = " Mintlify Domain"
35+ className = " block dark:hidden"
36+ />
37+
38+ <img
39+ src = " /images/quickstart/mintlify-domain-dark.png"
40+ alt = " Mintlify Domain"
41+ className = " hidden dark:block"
42+ />
3043</Frame >
3144
3245Your site's URL is available immediately. Use this URL for testing and sharing with your team while you are setting up your docs site.
@@ -44,8 +57,17 @@ Install the GitHub App by following the instructions from the onboarding checkli
44575 . Select the repositories that you want to connect.
4558
4659<Frame >
47- <img src = " /images/quickstart/github-app-installation-light.png" alt = " GitHub App Installation" className = " block dark:hidden" />
48- <img src = " /images/quickstart/github-app-installation-dark.png" alt = " GitHub App Installation" className = " hidden dark:block" />
60+ <img
61+ src = " /images/quickstart/github-app-installation-light.png"
62+ alt = " GitHub App Installation"
63+ className = " block dark:hidden"
64+ />
65+
66+ <img
67+ src = " /images/quickstart/github-app-installation-dark.png"
68+ alt = " GitHub App Installation"
69+ className = " hidden dark:block"
70+ />
4971</Frame >
5072
5173<Info >
@@ -83,13 +105,16 @@ The code-based workflow integrates with your existing development environment an
83105To work locally with your documentation, install the Command Line Interface (CLI), called [ mint] ( https://www.npmjs.com/package/mint ) , by running this command in your terminal:
84106
85107<CodeGroup >
86- ``` bash npm
87- npm i -g mint
88- ```
89108
90- ``` bash pnpm
91- pnpm add -g mint
92- ```
109+ ``` bash npm
110+ npm i -g mint
111+ ```
112+
113+
114+ ``` bash pnpm
115+ pnpm add -g mint
116+ ```
117+
93118</CodeGroup >
94119
95120<Info >
@@ -130,8 +155,17 @@ mint dev
130155Your preview will be available at ` localhost:3000 ` .
131156
132157<Frame >
133- <img src = " /images/quickstart/mintlify-dev-light.png" alt = " Mintlify Dev" className = " block dark:hidden" />
134- <img src = " /images/quickstart/mintlify-dev-dark.png" alt = " Mintlify Dev" className = " hidden dark:block" />
158+ <img
159+ src = " /images/quickstart/mintlify-dev-light.png"
160+ alt = " Mintlify Dev"
161+ className = " block dark:hidden"
162+ />
163+
164+ <img
165+ src = " /images/quickstart/mintlify-dev-dark.png"
166+ alt = " Mintlify Dev"
167+ className = " hidden dark:block"
168+ />
135169</Frame >
136170
137171### Push the changes
@@ -142,7 +176,7 @@ Mintlify automatically detects the changes, builds your documentation, and deplo
142176
143177After the deployment completes, your latest update will be available at ` <your-project-name>.mintlify.app ` .
144178
145- <Card title = " Jump to adding a custom domain" icon = " arrow-down" href = " #adding-a-custom-domain" horizontal >
179+ <Card title = " Jump to adding a custom domain" icon = " arrow-down" horizontal href = " #adding-a-custom-domain" >
146180 Optionally, skip the web editor workflow and jump to adding a custom domain.
147181</Card >
148182
@@ -160,8 +194,17 @@ The web editor workflow provides a what-you-see-is-what-you-get (WYSIWYG) interf
160194</Info >
161195
162196<Frame >
163- <img alt = " The Mintlify web editor in the visual editor mode" src = " /images/quickstart/web-editor-light.png" className = " block dark:hidden" />
164- <img alt = " The Mintlify web editor in the visual editor mode" src = " /images/quickstart/web-editor-dark.png" className = " hidden dark:block" />
197+ <img
198+ alt = " The Mintlify web editor in the visual editor mode"
199+ src = " /images/quickstart/web-editor-light.png"
200+ className = " block dark:hidden"
201+ />
202+
203+ <img
204+ alt = " The Mintlify web editor in the visual editor mode"
205+ src = " /images/quickstart/web-editor-dark.png"
206+ className = " hidden dark:block"
207+ />
165208</Frame >
166209
167210### Edit the documentation
@@ -173,12 +216,23 @@ Find and select `index.mdx` in the file explorer.
173216Then, in the editor, update the title field to "Hello World".
174217
175218<Frame >
176- <img alt = " Editing in Web Editor" src = " /images/quickstart/web-editor-editing-light.png" className = " block dark:hidden" />
177- <img alt = " Editing in Web Editor" src = " /images/quickstart/web-editor-editing-dark.png" className = " hidden dark:block" />
219+ <img
220+ alt = " Editing in Web Editor"
221+ src = " /images/quickstart/web-editor-editing-light.png"
222+ className = " block dark:hidden"
223+ />
224+
225+ <img
226+ alt = " Editing in Web Editor"
227+ src = " /images/quickstart/web-editor-editing-dark.png"
228+ className = " hidden dark:block"
229+ />
178230</Frame >
179231
180232<Tip >
181- The editor provides a rich set of formatting tools and components. Type <kbd >/</kbd > in the editor to open the command menu and access these tools.
233+ The editor provides a rich set of formatting tools and components. Type <kbd >/</kbd >
234+
235+ in the editor to open the command menu and access these tools.
182236</Tip >
183237
184238### Publish your changes
@@ -198,16 +252,25 @@ While your `<your-project-name>.mintlify.app` subdomain works well for testing a
198252To add a custom domain, navigate to the [ Domain Setup] ( https://dashboard.mintlify.com/settings/deployment/custom-domain ) page in your dashboard.
199253
200254<Frame >
201- <img src = " /images/quickstart/custom-domain-light.png" alt = " Custom Domain" className = " block dark:hidden" />
202- <img src = " /images/quickstart/custom-domain-dark.png" alt = " Custom Domain" className = " hidden dark:block" />
255+ <img
256+ src = " /images/quickstart/custom-domain-light.png"
257+ alt = " Custom Domain"
258+ className = " block dark:hidden"
259+ />
260+
261+ <img
262+ src = " /images/quickstart/custom-domain-dark.png"
263+ alt = " Custom Domain"
264+ className = " hidden dark:block"
265+ />
203266</Frame >
204267
205268Enter your domain (for example, ` docs.yourcompany.com ` ) and follow the provided instructions to configure DNS settings with your domain provider.
206269
207270<Table >
208- | Record Type | Name | Value | TTL |
209- | ------------- | ------| -------| -----|
210- | CNAME | docs (or subdomain) | cname.mintlify.app | 3600 |
271+ | Record Type | Name | Value | TTL |
272+ | ----------- | -- ----------------- | ------------------ | ---- |
273+ | CNAME | docs (or subdomain) | cname.mintlify.app | 3600 |
211274</Table >
212275
213276<Info >
@@ -218,19 +281,23 @@ Enter your domain (for example, `docs.yourcompany.com`) and follow the provided
218281
219282Congratulations! You have successfully deployed your documentation site with Mintlify. Here are suggested next steps to enhance your documentation:
220283
221- <Card title = " Configure your global settings" icon = " settings" href = " settings" horizontal >
284+ <Card title = " Configure your global settings" icon = " settings" horizontal href = " settings" >
222285 Configure site-wide styling, navigation, integrations, and more with the ` docs.json ` file.
223286</Card >
224- <Card title = " Customize your theme" icon = " paintbrush" href = " themes" horizontal >
287+
288+ <Card title = " Customize your theme" icon = " paintbrush" horizontal href = " themes" >
225289 Learn how to customize colors, fonts, and the overall appearance of your documentation site.
226290</Card >
227- <Card title = " Organize navigation" icon = " map" href = " navigation" horizontal >
291+
292+ <Card title = " Organize navigation" icon = " map" horizontal href = " navigation" >
228293 Structure your documentation with intuitive navigation to help users find what they need.
229294</Card >
230- <Card title = " Add interactive components" icon = " puzzle" href = " /components/accordions" horizontal >
295+
296+ <Card title = " Add interactive components" icon = " puzzle" horizontal href = " /components/accordions" >
231297 Enhance your documentation with interactive components like accordions, tabs, and code samples.
232298</Card >
233- <Card title = " Set up API references" icon = " code" href = " /api-playground/overview" horizontal >
299+
300+ <Card title = " Set up API references" icon = " code" horizontal href = " /api-playground/overview" >
234301 Create interactive API references with OpenAPI and AsyncAPI specifications.
235302</Card >
236303
@@ -248,4 +315,4 @@ If you encounter issues during the setup process, check these common troubleshoo
248315 <Accordion title = " Custom domain not connecting" >
249316 Verify that your DNS records are set up correctly and allow sufficient time for DNS propagation (up to 48 hours). You can use tools like [ DNSChecker] ( https://dnschecker.org ) to verify your CNAME record.
250317 </Accordion >
251- </AccordionGroup >
318+ </AccordionGroup >
0 commit comments