Skip to content

Commit a9f0e3e

Browse files
committed
Update ci.mdx
1 parent 6c073cf commit a9f0e3e

File tree

1 file changed

+316
-19
lines changed

1 file changed

+316
-19
lines changed

settings/ci.mdx

Lines changed: 316 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ icon: "circle-check"
88
CI checks are available on [Growth and Enterprise plans](https://mintlify.com/pricing?ref=docs-ci), an add-on for other plans, and for GitHub.
99
</Info>
1010

11-
Use CI checks to lint your docs for errors and provide warnings before you deploy.
11+
Use CI checks to lint your docs for errors and provide warnings before you deploy. CI checks are configured to run on commits to your configured deployment branch, or on pull requests against that branch.
1212

1313
## Installation
1414

@@ -18,28 +18,20 @@ For GitHub Apps, you can choose to give permissions to only a single repository.
1818

1919
## Configuration
2020

21-
Configure the CI checks enabled for a deployment on the Mintlify dashboard by navigating to the 'Add-Ons' tab. There you can enable or disable the checks you'd like to run.
21+
Configure the CI checks enabled for a deployment by navigating to the [Add-ons](https://dashboard.mintlify.com/products/addons) page of your dashboard. Enable the checks that you want to run.
2222

2323
When enabling checks, you can choose to run them at a `Warning` or `Blocking` level.
2424

25-
<Note>
25+
- A `Warning` level check will never provide a failure status, even if there is an error or suggestions.
26+
- A `Blocking` level check will provide a failure status if not passed, or changes are suggested.
2627

28+
## Available CI checks
2729

28-
A `Blocking` level check will provide a failure status if not passed, or changes are suggested.<br/>
30+
### Broken links
2931

30-
A `Warning` level check will never provide a failure status, even if there is an error or suggestions.
32+
Similar to how the [CLI link checker](/settings/broken-links#broken-links) works on your local machine, we automatically check your docs for broken links.
3133

32-
</Note>
33-
34-
## When Do They Run?
35-
36-
CI checks are configured to run on commits to your configured deployment branch, or on pull requests against that branch.
37-
38-
## Available CI Checks
39-
40-
### Broken Links
41-
42-
Similar to how the [CLI link checker](/settings/broken-links#broken-links) works on your local machine, we automatically check your docs for broken links. To see the results of this check, visit GitHub's check results page for a specific commit.
34+
To see the results of this check, visit GitHub's check results page for a specific commit.
4335

4436
### Vale
4537

@@ -50,7 +42,312 @@ Mintlify supports automatically running Vale in a CI check and displaying the re
5042
#### Configuration
5143
If you have a `.vale.ini` file in the root content directory for your deployment, we automatically use that configuration file. We also automatically use any configuration files in your specified `stylesPath`.
5244

53-
<Tip>Don't have a Vale config or not sure where to get started? Don't worry, Mintlify has a default configuration that automatically loads if one is not provided.</Tip>
45+
If you do not have a Vale config file, the default configuration automatically loads.
46+
47+
````mdx Default vale.ini configuration expandable
48+
# Top level styles
49+
StylesPath = /app/styles
50+
MinAlertLevel = suggestion
51+
IgnoredScopes = code, tt, img, url, a
52+
SkippedScopes = script, style, pre, figure, code
53+
54+
# Vocabularies
55+
Vocab = Mintlify
56+
57+
# This is required since Vale doesn't officially support MDX
58+
[formats]
59+
mdx = md
60+
61+
# MDX support
62+
[*.mdx]
63+
BasedOnStyles = Vale
64+
Vale.Terms = NO # Enforces really harsh capitalization rules, keep off
65+
66+
# `import ...`, `export ...`
67+
# `<Component ... />`
68+
# `<Component>...</Component>`
69+
# `{ ... }`
70+
TokenIgnores = (?sm)((?:import|export) .+?$), \
71+
(?<!`)(<\w+ ?.+ ?\/>)(?!`), \
72+
(<[A-Z]\w+>.+?<\/[A-Z]\w+>)
73+
74+
# Exclude:
75+
# `<Component \n ... />`
76+
BlockIgnores = (?sm)^(<\w+\n .*\s\/>)$, \
77+
(?sm)^({.+.*})
78+
79+
CommentDelimiters = {/*, */}
80+
````
81+
82+
```text Default Vale vocabulary expandable
83+
Mintlify
84+
mintlify
85+
VSCode
86+
openapi
87+
OpenAPI
88+
Github
89+
APIs
90+
91+
repo
92+
npm
93+
dev
94+
95+
Lorem
96+
ipsum
97+
impsum
98+
amet
99+
100+
const
101+
myName
102+
myObject
103+
bearerAuth
104+
favicon
105+
topbar
106+
url
107+
borderRadius
108+
args
109+
modeToggle
110+
ModeToggle
111+
isHidden
112+
autoplay
113+
114+
_italic_
115+
Strikethrough
116+
Blockquotes
117+
Blockquote
118+
Singleline
119+
Multiline
120+
121+
onboarding
122+
123+
async
124+
await
125+
boolean
126+
enum
127+
func
128+
impl
129+
init
130+
instanceof
131+
typeof
132+
params
133+
stdin
134+
stdout
135+
stderr
136+
stdout
137+
stdin
138+
var
139+
const
140+
let
141+
null
142+
undefined
143+
struct
144+
bool
145+
146+
cors
147+
csrf
148+
env
149+
xhr
150+
xhr2
151+
jwt
152+
oauth
153+
websocket
154+
localhost
155+
middleware
156+
runtime
157+
webhook
158+
stdin
159+
stdout
160+
161+
json
162+
yaml
163+
yml
164+
md
165+
txt
166+
tsx
167+
jsx
168+
css
169+
scss
170+
html
171+
png
172+
jpg
173+
svg
174+
175+
cdn
176+
cli
177+
css
178+
dom
179+
dto
180+
env
181+
git
182+
gui
183+
http
184+
https
185+
ide
186+
jvm
187+
mvc
188+
orm
189+
rpc
190+
sdk
191+
sql
192+
ssh
193+
ssl
194+
tcp
195+
tls
196+
uri
197+
url
198+
ux
199+
ui
200+
201+
nodejs
202+
npm
203+
yarn
204+
pnpm
205+
eslint
206+
pytest
207+
golang
208+
rustc
209+
kubectl
210+
mongo
211+
postgres
212+
redis
213+
214+
JavaScript
215+
TypeScript
216+
Python
217+
Ruby
218+
Rust
219+
Go
220+
Golang
221+
Java
222+
Kotlin
223+
Swift
224+
Node.js
225+
NodeJS
226+
Deno
227+
228+
React
229+
Vue
230+
Angular
231+
Next.js
232+
Nuxt
233+
Express
234+
Django
235+
Flask
236+
Spring
237+
Laravel
238+
Redux
239+
Vuex
240+
TensorFlow
241+
PostgreSQL
242+
MongoDB
243+
Redis
244+
PNPM
245+
246+
Docker
247+
Kubernetes
248+
AWS
249+
Azure
250+
GCP
251+
Terraform
252+
Jenkins
253+
CircleCI
254+
GitLab
255+
Heroku
256+
257+
Git
258+
git
259+
GitHub
260+
GitLab
261+
Bitbucket
262+
VSCode
263+
Visual Studio Code
264+
IntelliJ
265+
WebStorm
266+
ESLint
267+
eslint
268+
Prettier
269+
prettier
270+
Webpack
271+
webpack
272+
Vite
273+
vite
274+
Babel
275+
babel
276+
Jest
277+
jest
278+
Mocha
279+
Cypress
280+
Postman
281+
282+
HTTP
283+
HTTPS
284+
OAuth
285+
JWT
286+
GraphQL
287+
REST
288+
WebSocket
289+
TCP/IP
290+
291+
NPM
292+
Yarn
293+
PNPM
294+
Pip
295+
PIP
296+
Cargo
297+
RubyGems
298+
299+
Swagger
300+
OpenAPI
301+
Markdown
302+
MDX
303+
Storybook
304+
TypeDoc
305+
JSDoc
306+
307+
MySQL
308+
PostgreSQL
309+
MongoDB
310+
Redis
311+
Elasticsearch
312+
DynamoDB
313+
314+
Linux
315+
Unix
316+
macOS
317+
iOS
318+
319+
Firefox
320+
Chromium
321+
WebKit
322+
323+
config
324+
ctx
325+
desc
326+
dir
327+
elem
328+
err
329+
len
330+
msg
331+
num
332+
obj
333+
prev
334+
proc
335+
ptr
336+
req
337+
res
338+
str
339+
tmp
340+
val
341+
vars
342+
343+
todo
344+
href
345+
lang
346+
nav
347+
prev
348+
next
349+
toc
350+
```
54351

55352
<Warning>
56353
Please note that for security reasons, we are unable to support any absolute `stylesPath`, or `stylesPath` which include `..` values. Please use relative paths and include the `stylesPath` in your repository.
@@ -66,8 +363,8 @@ For packages not included in your repository, you may specify any packages from
66363
Please note that for security reasons, we are unable to support automatically downloading packages that are not from the [Vale package registry](https://vale.sh/explorer).
67364
</Warning>
68365

69-
#### Vale with MDX
70-
Vale does not natively support MDX, but Vale's author has provided a [custom extension](https://github.com/errata-ai/MDX) to support it.
366+
#### Vale with `MDX`
367+
Vale does not natively support `MDX`, but Vale's author has provided a [custom extension](https://github.com/errata-ai/MDX) to support it.
71368

72369
If you prefer not to use this extension, we recommend the following lines in your `.vale.ini` file:
73370
```ini

0 commit comments

Comments
 (0)