Skip to content

Commit 32d2f81

Browse files
authored
Add mint a11y CLI command (#1448)
* add `mint a11y` command * copy edit other commands
1 parent 95afbd6 commit 32d2f81

File tree

1 file changed

+19
-13
lines changed

1 file changed

+19
-13
lines changed

installation.mdx

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -98,37 +98,43 @@ mint dev --group admin
9898

9999
## Additional commands
100100

101-
While `mint dev` is the most commonly used command, there are other commands you can use to manage your documentation.
101+
### Find broken links
102102

103-
### Finding broken links
104-
105-
The CLI can assist with validating reference links made in your documentation. To identify any broken links, use the following command:
103+
Identify any broken internal links with the following command:
106104

107105
```bash
108106
mint broken-links
109107
```
110108

111-
### Checking OpenAPI spec
109+
### Find accessibility issues
110+
111+
Test the color contrast ratios and search for missing alt text on images and videos in your documentation with the following command:
112+
113+
```bash
114+
mint a11y
115+
```
116+
117+
### Check OpenAPI spec
112118

113-
You can use the CLI to check your OpenAPI file for errors using the following command:
119+
Check your OpenAPI file for errors with the following command:
114120

115121
```bash
116-
mint openapi-check <openapiFilenameOrUrl>
122+
mint openapi-check <OpenAPI filename or URL>
117123
```
118124

119-
You can pass in a filename (for example, `./openapi.yaml`) or a URL (for example, `https://petstore3.swagger.io/api/v3/openapi.json`).
125+
Pass a filename (for example, `./openapi.yaml`) or a URL (for example, `https://petstore3.swagger.io/api/v3/openapi.json`).
120126

121-
### Renaming files
127+
### Rename files
122128

123-
You can rename and update all references to files using the following command:
129+
Rename and update all references to files with the following command:
124130

125131
```bash
126-
mint rename <oldFilename> <newFilename>
132+
mint rename <path/to/old-filename> <path/to/new-filename>
127133
```
128134

129-
### Migrating MDX endpoint pages
135+
### Migrate MDX endpoint pages
130136

131-
You can migrate MDX endpoint pages to autogenerated pages from your OpenAPI specification using the following command:
137+
Migrate MDX endpoint pages to autogenerated pages from your OpenAPI specification with the following command:
132138

133139
```bash
134140
mint migrate-mdx

0 commit comments

Comments
 (0)