Configuration

HyperLint offers a variety of configuration options. To customize settings, edit the .hyperlint/config.yaml file within your GitHub repository. Configuration syntax is in YAML format, and options may differ slightly depending on your subscription plan (e.g., Free, Starter, etc.).

Repository Configuration

Configurations are set on per repository basis to ensure that hyperlint behaves as expected.

Configuration are configured by creating a file in the repository at .hyperlint/config.yaml.

See an example in our demo repository repository.

Configuration properties

content_dir

This is the root directory for content files. The default is / and, when you ask for a review, hyperlint will analyze every file in that pull request. If that file is of a supported type. Default: "/".

Examples:

content_dir: /

content_dir: /content

content_dir: /docs

authorized_users

This field specifies which users are allowed to trigger Hyperlint. To use it, provide a list of GitHub handles. If you would like any and all users to trigger Hyperlint, add '*' to the list. Default: ['*'].

Examples:

authorized_users:
  - octocat
  - octocat2

authorized_users:
  - '*'

authorized_users:
  - octocat

Example full configuration

Here's a full configuration that you can use as a starting point:

content_dir: /docs
authorized_users:
  - octocat
  - octocat2