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: README.md
+7-12Lines changed: 7 additions & 12 deletions
Original file line number
Diff line number
Diff line change
@@ -5,15 +5,10 @@ The repo is based on the Mintlify framework and the content is in Markdown forma
5
5
## Setup
6
6
7
7
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.
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.
17
12
18
13
```
19
14
vale sync
@@ -29,15 +24,15 @@ Optional: install the following VS Code extensions:
29
24
Run the following in your terminal to build the documentation locally:
30
25
31
26
```
32
-
npm run mintlify dev
27
+
mint dev
33
28
```
34
29
35
30
## Check for broken links
36
31
37
32
Run the following in your terminal to check for broken links:
38
33
39
34
```
40
-
npm run mintlify broken-links
35
+
mint broken-links
41
36
```
42
37
43
38
## Ensure consistent style
@@ -65,5 +60,5 @@ We value your input and invite you to help us make the Axiom documentation even
65
60
66
61
## Troubleshooting
67
62
68
-
- If the local build fails, run `npm run mintlify install` to re-install dependencies.
63
+
- If the local build fails, run `mint update`.
69
64
- 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