lychee.toml

# Cache the results of Lychee if ran locally in order to minimise the chance of rate limiting
cache = true

# Discard all cached requests older than this duration.
max_cache_age = "1d"
# Ignore all private link (such as localhost) to avoid errors
exclude_all_private = true
# HTTP status code: 429 (Too Many Requests) will also be treated as a valid link if Lychee gets rate limited
accept = [200, 201, 204, 206, 300, 301, 302, 303, 304, 307, 308, 999]

# Base URL or website root directory to check relative URLs.
base_url = "https://nuxt.com/"

no_progress = true

# Enable checking of fragments/anchors in links (e.g., #section-name)
# include_fragments = true

# Follow redirects
max_redirects = 3

# Set user agent to avoid bot blocking
user_agent = "Mozilla/5.0 (compatible; lychee link checker)"

# Set reasonable timeout and retry values
timeout = 20
retry_wait_time = 2
max_retries = 6
# Throttle per host to reduce rate limits / connection failures from external docs in CI
host_request_interval = "50ms"
host_concurrency = 5

# Explicitly exclude some URLs
exclude = [
  "https://twitter.nuxt.dev/",
  "https://www.webpagetest.org/",
  "https://stackoverflow.com/help/minimal-reproducible-example",
  "https://gsap.com/",
  # external docs sites that block or rate-limit CI bots
  'https://router.vuejs.org/(.*)',
  'https://vitest.dev/(.*)',
  'https://vite.dev/(.*)',
  # dummy example URLs
  "https://myawesome-lib.js/",
  "https://awesome-lib.js/",
  "https://myawesome-lib.css/",
  "https://awesome-lib.css/",
  "https://mycdn.org/",
  "https://nuxt.new/c/v4",
  "https://nuxt.new/s/v4",
  "https://www.npmjs.com/",
  'https://nuxt\.com/docs/4\.x/api/composables/\$%7BkebabCase\(factory\.name\)%7D.*',
  # TODO: fix upstream API issues
  "https://nuxt.com/modules",
  # single-quotes are required for regexp
  'https://res.cloudinary.com/nuxt/video/upload/(.*)',
  'https://www.npmjs.com/package/(.*)',
  '(https?:\/\/github\.com\/)(.*\/)(generate)',
  "https://github.com/nuxt-contrib/vue3-ssr-starter/generate",
  # GitHub URLs that redirect to login in unauthenticated CI
  'https://github.com/(.*)/issues/new(.*)',
  'https://github.com/(.*)/edit/(.*)',
  # Discord invite redirects
  'https://go.nuxt.com/discord',
  # excluded URLs from test suite
  "http://auth.com",
  "http://example1.com/",
  "http://example2.com/",
  "http://example3.com/",
  "~images/main-bg.jpg",
]