You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: quickstart.mdx
+10-40Lines changed: 10 additions & 40 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -47,17 +47,11 @@ Then authorize your account:
47
47
48
48
Pick the workflow that fits your team:
49
49
50
-
## Code-based workflow
50
+
###Code-based workflow
51
51
52
-
The code-based workflow integrates with your existing development environment and Git repositories. This workflow is best for technical teams who want to manage documentation alongside code.
52
+
Work locally with your code editor and Git.
53
53
54
-
### Install the CLI
55
-
56
-
<Info>
57
-
**Prerequisite**: The CLI requires [Node.js](https://nodejs.org/en) v19 or higher.
58
-
</Info>
59
-
60
-
To 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:
54
+
**Install the CLI** (requires [Node.js](https://nodejs.org/en) v19+):
61
55
62
56
<CodeGroup>
63
57
```bash npm
@@ -69,25 +63,13 @@ To work locally with your documentation, install the Command Line Interface (CLI
69
63
```
70
64
</CodeGroup>
71
65
72
-
### Create a new project
73
-
74
-
Run `mint new` to create a new documentation project. See the [CLI installation guide](/installation#create-a-new-project) for details on the command and flags.
66
+
**Create a project**:
75
67
76
-
### Edit the documentation
77
-
78
-
After setting up your project, you can start editing your documentation files. For example, update the title of the introduction page:
79
-
80
-
1. Navigate to your documentation repository.
81
-
2. Open `index.mdx` and locate the top of the file:
82
-
83
-
```mdx index.mdx
84
-
---
85
-
title: "Introduction"
86
-
description: "This is the introduction to the documentation"
87
-
---
68
+
```bash
69
+
mint new
88
70
```
89
71
90
-
3. Update the `title` field to `"Hello World"`.
72
+
**Edit your docs**. Open `index.mdx` and change the title:
91
73
92
74
```mdx index.mdx {2}
93
75
---
@@ -96,32 +78,20 @@ description: "This is the introduction to the documentation"
96
78
---
97
79
```
98
80
99
-
### Preview the changes
100
-
101
-
To preview the changes locally, run the following command:
When you are ready to publish your changes, push them to your repository.
117
-
118
-
Mintlify automatically detects the changes, builds your documentation, and deploys the updates to your site. Monitor the deployment status in your GitHub repository commit history or the [dashboard](https://dashboard.mintlify.com).
119
-
120
-
After the deployment completes, your latest update will be available at `<your-project-name>.mintlify.app`.
121
-
122
-
<Cardtitle="Jump to adding a custom domain"icon="arrow-down"href="#adding-a-custom-domain"horizontal>
123
-
Optionally, skip the web editor workflow and jump to adding a custom domain.
124
-
</Card>
94
+
**Push to deploy**. Mintlify automatically builds and deploys your changes.
0 commit comments