From 0385285749c4c090213b81a58a33e19b1a2b593d Mon Sep 17 00:00:00 2001 From: rina Date: Sun, 16 Nov 2025 14:14:58 +1000 Subject: [PATCH] docs: use markdown formatting for files-from help text it was _almost_ markdown. by making it compatible with real markdown, we can get rich text for the website :) for https://www.github.com/lycheeverse/lycheeverse.github.io/pull/113#issuecomment-3506611996 --- README.md | 13 +++++++------ lychee-bin/src/options.rs | 13 +++++++------ 2 files changed, 14 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index fef6062a1f..01248ae0ed 100644 --- a/README.md +++ b/README.md @@ -487,14 +487,15 @@ Options: cumbersome to specify on the command line directly. Examples: - lychee --files-from list.txt - find . -name '*.md' | lychee --files-from - - echo 'README.md' | lychee --files-from - + + lychee --files-from list.txt + find . -name '*.md' | lychee --files-from - + echo 'README.md' | lychee --files-from - File Format: - Each line should contain one input (file path, URL, or glob pattern). - Lines starting with '#' are treated as comments and ignored. - Empty lines are also ignored. + - Each line should contain one input (file path, URL, or glob pattern). + - Lines starting with '#' are treated as comments and ignored. + - Empty lines are also ignored. --generate Generate special output (e.g. the man page) instead of performing link checking diff --git a/lychee-bin/src/options.rs b/lychee-bin/src/options.rs index f0891b7663..857c3f6b64 100644 --- a/lychee-bin/src/options.rs +++ b/lychee-bin/src/options.rs @@ -398,14 +398,15 @@ This is useful when you have a large number of inputs that would be cumbersome to specify on the command line directly. Examples: - lychee --files-from list.txt - find . -name '*.md' | lychee --files-from - - echo 'README.md' | lychee --files-from - + + lychee --files-from list.txt + find . -name '*.md' | lychee --files-from - + echo 'README.md' | lychee --files-from - File Format: - Each line should contain one input (file path, URL, or glob pattern). - Lines starting with '#' are treated as comments and ignored. - Empty lines are also ignored." +- Each line should contain one input (file path, URL, or glob pattern). +- Lines starting with '#' are treated as comments and ignored. +- Empty lines are also ignored." )] files_from: Option,