Skip to content

Commit 6325798

Browse files
authored
Update mint CLI settings and readme (#317)
1 parent 1f53fff commit 6325798

File tree

3 files changed

+7
-10206
lines changed

3 files changed

+7
-10206
lines changed

README.md

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,10 @@ The repo is based on the Mintlify framework and the content is in Markdown forma
55
## Setup
66

77
1. Install the latest LTS version of [Node.js](https://nodejs.org/en/download/package-manager).
8-
2. Install [Vale](https://vale.sh/docs/install).
9-
3. Fork this repo, and then clone it. For more information, see the [GitHub documentation](https://docs.github.com/en/get-started/exploring-projects-on-github/contributing-to-a-project).
10-
4. Go to the root folder in your terminal, and run the following to install Node dependencies:
11-
12-
```
13-
npm i
14-
```
15-
16-
5. Run the following in your terminal to sync the Vale style packages.
8+
1. Install [Vale](https://vale.sh/docs/install).
9+
1. Install [Mint CLI](https://mintlify.com/docs/installation).
10+
1. Fork this repo, and then clone it. For more information, see the [GitHub documentation](https://docs.github.com/en/get-started/exploring-projects-on-github/contributing-to-a-project).
11+
1. Run the following in your terminal to sync the Vale style packages.
1712

1813
```
1914
vale sync
@@ -29,15 +24,15 @@ Optional: install the following VS Code extensions:
2924
Run the following in your terminal to build the documentation locally:
3025
3126
```
32-
npm run mintlify dev
27+
mint dev
3328
```
3429
3530
## Check for broken links
3631
3732
Run the following in your terminal to check for broken links:
3833
3934
```
40-
npm run mintlify broken-links
35+
mint broken-links
4136
```
4237
4338
## Ensure consistent style
@@ -65,5 +60,5 @@ We value your input and invite you to help us make the Axiom documentation even
6560
6661
## Troubleshooting
6762
68-
- If the local build fails, run `npm run mintlify install` to re-install dependencies.
63+
- If the local build fails, run `mint update`.
6964
- If a page loads as a 404, make sure you run the local build in the root folder where the file `docs.json` is present.

0 commit comments

Comments
 (0)