Skip to content

Commit fa86f07

Browse files
Update quickstart.mdx
1 parent 0a0fa17 commit fa86f07

File tree

1 file changed

+10
-40
lines changed

1 file changed

+10
-40
lines changed

quickstart.mdx

Lines changed: 10 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -47,17 +47,11 @@ Then authorize your account:
4747

4848
Pick the workflow that fits your team:
4949

50-
## Code-based workflow
50+
### Code-based workflow
5151

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.
5353

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+):
6155

6256
<CodeGroup>
6357
```bash npm
@@ -69,25 +63,13 @@ To work locally with your documentation, install the Command Line Interface (CLI
6963
```
7064
</CodeGroup>
7165

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**:
7567

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
8870
```
8971

90-
3. Update the `title` field to `"Hello World"`.
72+
**Edit your docs**. Open `index.mdx` and change the title:
9173

9274
```mdx index.mdx {2}
9375
---
@@ -96,32 +78,20 @@ description: "This is the introduction to the documentation"
9678
---
9779
```
9880

99-
### Preview the changes
100-
101-
To preview the changes locally, run the following command:
81+
**Preview locally**:
10282

10383
```bash
10484
mint dev
10585
```
10686

107-
Your preview is available at `localhost:3000`.
87+
Your preview is at `localhost:3000`.
10888

10989
<Frame>
11090
<img src="/images/quickstart/mintlify-dev-light.png" alt="Mintlify Dev" className="block dark:hidden" />
11191
<img src="/images/quickstart/mintlify-dev-dark.png" alt="Mintlify Dev" className="hidden dark:block" />
11292
</Frame>
11393

114-
### Push the changes
115-
116-
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-
<Card title="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.
12595

12696
## Web editor workflow
12797

0 commit comments

Comments
 (0)