Skip to main content

Module source

Module source 

Source
Expand description

Input source type definitions.

lychee can handle different kinds of input sources:

  • URLs (of HTTP/HTTPS scheme)
  • File system paths (to files or directories)
  • Unix shell-style glob patterns (e.g. ./docs/**/*.md)
  • Standard input (stdin)
  • Raw strings (UTF-8 only for now)

Each input source is handled differently:

  • File paths are walked (if they are directories) and filtered by extension
  • Glob patterns are expanded to matching file paths, which are then walked and filtered by extension
  • URLs, raw strings, and standard input (stdin) are read directly

Enumsยง

InputSource
Input types which lychee supports
ResolvedInputSource
Resolved input sources that can be processed for content.