Pro- und Enterprise-Pläne enthalten CI-Checks für GitHub-Repositories.
Verwenden Sie CI-Checks, um Ihre Dokumentation zu linten, Fehler zu erkennen und vor der Bereitstellung Warnungen auszugeben. CI-Checks sind so konfiguriert, dass sie bei Commits auf Ihrem konfigurierten Deployment-Branch oder bei Pull Requests gegen diesen Branch ausgeführt werden.

​
Installation

Beginnen Sie, indem Sie den Schritten auf der Seite GitHub folgen. Bei GitHub-Apps können Sie die Berechtigungen auf ein einzelnes Repository beschränken. Das empfehlen wir ausdrücklich, da wir nur Zugriff auf das Repository benötigen, in dem Ihre Dokumentation gehostet wird.

​
Konfiguration

Konfigurieren Sie die für eine Bereitstellung aktivierten CI-Prüfungen, indem Sie in Ihrem Dashboard zur Seite Add-ons navigieren. Aktivieren Sie die Prüfungen, die Sie ausführen möchten. Beim Aktivieren von Prüfungen können Sie auswählen, ob diese auf der Stufe Warning oder Blocking ausgeführt werden.
  • Eine Prüfung auf der Stufe Warning führt niemals zu einem Fehlstatus, selbst wenn Fehler oder Vorschläge vorliegen.
  • Eine Prüfung auf der Stufe Blocking führt zu einem Fehlstatus, wenn sie nicht bestanden wird oder Änderungen vorgeschlagen werden.

​
Verfügbare CI-Checks

Ähnlich wie der CLI-Link-Checker auf deinem lokalen Rechner überprüft, prüfen wir deine Dokumentation automatisch auf defekte Links. Um die Ergebnisse dieser Prüfung zu sehen, rufe auf GitHub die Ergebnisseite für einen bestimmten Commit auf.

​
Vale

Vale ist ein quelloffener, regelbasierter Prosa-Linter, der eine Reihe von Dokumenttypen unterstützt, darunter Markdown und MDX. Mintlify unterstützt das automatische Ausführen von Vale in einem CI-Check und zeigt die Ergebnisse als Prüfstatus an.

​
Konfiguration

Wenn sich im Stammverzeichnis Ihrer Inhalte für die Bereitstellung eine Datei .vale.ini befindet, verwenden wir diese Konfigurationsdatei automatisch. Wir verwenden außerdem automatisch alle Konfigurationsdateien in Ihrem angegebenen stylesPath. Wenn Sie keine Vale-Konfigurationsdatei haben, wird die Standardkonfiguration automatisch geladen.
Default vale.ini configuration
# Top level styles
StylesPath = /app/styles
MinAlertLevel = suggestion
IgnoredScopes = code, tt, img, url, a
SkippedScopes = script, style, pre, figure, code

# Vocabularies
Vocab = Mintlify

# This is required since Vale doesn't officially support MDX
[formats]
mdx = md

# MDX support
[*.mdx]
BasedOnStyles = Vale
Vale.Terms = NO # Enforces really harsh capitalization rules, keep off

# `import ...`, `export ...`
# `<Component ... />`
# `<Component>...</Component>`
# `{ ... }`
TokenIgnores = (?sm)((?:import|export) .+?$), \
(?<!`)(<\w+ ?.+ ?\/>)(?!`), \
(<[A-Z]\w+>.+?<\/[A-Z]\w+>)

# Exclude:
# `<Component \n ... />`
BlockIgnores = (?sm)^(<\w+\n .*\s\/>)$, \
(?sm)^({.+.*})

CommentDelimiters = {/*, */}
Default Vale vocabulary
Mintlify
mintlify
VSCode
openapi
OpenAPI
Github
APIs

repo
npm
dev

Lorem
ipsum
impsum
amet

const
myName
myObject
bearerAuth
favicon
topbar
url
borderRadius
args
modeToggle
ModeToggle
isHidden
autoplay

_italic_
Strikethrough
Blockquotes
Blockquote
Singleline
Multiline

onboarding

async
await
boolean
enum
func
impl
init
instanceof
typeof
params
stdin
stdout
stderr
stdout
stdin
var
const
let
null
undefined
struct
bool

cors
csrf
env
xhr
xhr2
jwt
oauth
websocket
localhost
middleware
runtime
webhook
stdin
stdout

json
yaml
yml
md
txt
tsx
jsx
css
scss
html
png
jpg
svg

cdn
cli
css
dom
dto
env
git
gui
http
https
ide
jvm
mvc
orm
rpc
sdk
sql
ssh
ssl
tcp
tls
uri
url
ux
ui

nodejs
npm
yarn
pnpm
eslint
pytest
golang
rustc
kubectl
mongo
postgres
redis

JavaScript
TypeScript
Python
Ruby
Rust
Go
Golang
Java
Kotlin
Swift
Node.js
NodeJS
Deno

React
Vue
Angular
Next.js
Nuxt
Express
Django
Flask
Spring
Laravel
Redux
Vuex
TensorFlow
PostgreSQL
MongoDB
Redis
PNPM

Docker
Kubernetes
AWS
Azure
GCP
Terraform
Jenkins
CircleCI
GitLab
Heroku

Git
git
GitHub
GitLab
Bitbucket
VSCode
Visual Studio Code
IntelliJ
WebStorm
ESLint
eslint
Prettier
prettier
Webpack
webpack
Vite
vite
Babel
babel
Jest
jest
Mocha
Cypress
Postman

HTTP
HTTPS
OAuth
JWT
GraphQL
REST
WebSocket
TCP/IP

NPM
Yarn
PNPM
Pip
PIP
Cargo
RubyGems

Swagger
OpenAPI
Markdown
MDX
Storybook
TypeDoc
JSDoc

MySQL
PostgreSQL
MongoDB
Redis
Elasticsearch
DynamoDB

Linux
Unix
macOS
iOS

Firefox
Chromium
WebKit

config
ctx
desc
dir
elem
err
len
msg
num
obj
prev
proc
ptr
req
res
str
tmp
val
vars

todo
href
lang
nav
prev
next
toc
Bitte beachten Sie, dass wir aus Sicherheitsgründen keine absoluten stylesPath-Angaben oder stylesPath-Angaben unterstützen können, die .. enthalten. Verwenden Sie bitte relative Pfade und nehmen Sie den stylesPath in Ihr Repository auf.

​
Pakete

Vale unterstützt eine Reihe von Paketen, die zur Prüfung auf Rechtschreib- und Stilfehler verwendet werden können. Alle Pakete, die Sie in Ihrem Repository unter dem korrekten stylesPath ablegen, werden automatisch installiert und in Ihrer Vale-Konfiguration verwendet. Für Pakete, die nicht in Ihrem Repository enthalten sind, können Sie beliebige Pakete aus dem Vale-Paketregister angeben; diese werden automatisch heruntergeladen und in Ihrer Vale-Konfiguration verwendet.
Bitte beachten Sie, dass wir aus Sicherheitsgründen das automatische Herunterladen von Paketen, die nicht aus dem Vale-Paketregister stammen, nicht unterstützen können.

​
Vale mit MDX

Vale unterstützt MDX nicht nativ, aber der Autor von Vale hat eine benutzerdefinierte Erweiterung bereitgestellt, um es zu unterstützen. Wenn du diese Erweiterung nicht verwenden möchtest, empfehlen wir die folgenden Zeilen in deiner .vale.ini-Datei: 
[formats]
mdx = md

[*.mdx]
CommentDelimiters = {/*, */}

TokenIgnores = (?sm)((?:import|export) .+?$), \
(?<!`)(<\w+ ?.+ ?\/>)(?!`), \
(<[A-Z]\w+>.+?<\/[A-Z]\w+>)

BlockIgnores = (?sm)^(<\w+\n .*\s\/>)$, \
(?sm)^({.+.*})
Um die Kommentare innerhalb von Dokumenten in Vale zu nutzen, verwende MDX-Kommentare {/* ... */}. Wenn du die Einstellung CommentDelimiters = {/*, */} in deiner Konfiguration setzt, interpretiert Vale diese Kommentare beim Linting automatisch. Das bedeutet, dass du die integrierten Funktionen von Vale, wie das Überspringen von Zeilen oder Abschnitten, einfach nutzen kannst. 
{/* vale off */}

Dieser Text wird von Vale ignoriert

{/* vale on */}
Wenn du dich entscheidest, CommentDelimiters nicht zu verwenden, aber dennoch die Kommentare von Vale nutzen möchtest, musst du alle Vale-Kommentare in MDX-Kommentare {/* ... */} einschließen. Zum Beispiel: 
{/* <!-- vale off --> */}

Dieser Text wird von Vale ignoriert

{/* <!-- vale on --> */}
Diese Kommentar-Tags werden innerhalb von Mintlify-Komponenten nicht unterstützt, können jedoch überall auf der obersten Ebene eines Dokuments verwendet werden.