Skip to content
Hyperlint Docs

Configuration

Configuration

HyperLint offers a variety of configuration options through the .hyperlint/config.yaml file in your GitHub repository. Configuration is in YAML format.

Repository Configuration

Configurations are set per repository and must be in .hyperlint/config.yaml. This file is only read from the main branch.

One thing to note is that to avoid overloading the GitHub API, we cache the config file in the .hyperlint/config.yaml file. It may take several minutes to propagate config file changes.

Here are the key configuration properties:

content_dir

  • Specifies the root directory for content files
  • Default: ”/”
  • Examples: ”/”, “/content”, “/docs”
  • We will not review any files outside of this directory
content_dir: "/docs"

vale_style_guide

  • Enables/disables the Vale style guide checker
  • Default: enabled
  • Note: This feature is currently EXPERIMENTAL
vale_style_guide:
  enabled: true

custom_style_guide

  • Enables/disables custom style guide checking
  • Default: enabled
  • Optional: Specify path to style guide file with path_to_style_guide
custom_style_guide:
  enabled: true
  path_to_style_guide: ".hyperlint/style_guide.md" # note this MUST be an absolute path from the root of the repository

The path_to_style_guide can also begin with a / which will be interpreted as a path relative to the root of the repository.

  • Enables/disables link checking functionality
  • Default: enabled
link_check:
  enabled: true

Full Example Yaml

content_dir: "/docs"
vale_style_guide:
  enabled: true
custom_style_guide:
  enabled: true
  path_to_style_guide: "/.hyperlint/style_guide.md"
link_check:
  enabled: true