Fetch readme and generate Markdown for CLI flags at build time

astro.config.mjs

@@ -1,10 +1,20 @@
 import starlight from "@astrojs/starlight";
 import { defineConfig } from "astro/config";
+import smartypants from "remark-smartypants";
+import { generateCliOptionsIntegration } from "./src/generate-cli-options";
 
 // https://astro.build/config
 export default defineConfig({
 	site: "https://lychee.cli.rs",
+	markdown: {
+		remarkPlugins: [
+			// automatically converting smart dashes causes problems with cli arguments.
+			// to insert dashes, use unicode or — or –.
+			[smartypants, { dashes: false }],
+		],
+	},
 	integrations: [
+		generateCliOptionsIntegration("src/content/docs/guides/_cli.md"),
 		starlight({
 			expressiveCode: {
 				themes: ["catppuccin-frappe", "catppuccin-latte"],
@@ -38,11 +48,11 @@ export default defineConfig({
 					label: "Guides",
 					items: [
 						"guides/getting-started",
-						"guides/library",
-						"guides/config",
 						"guides/cli",
+						"guides/config",
 						"guides/output",
 						"guides/preprocessing",
+						"guides/library",
 					],
 				},
 				{

package.json

@@ -20,6 +20,7 @@
 		"@astrojs/check": "^0.9.5",
 		"@astrojs/starlight": "^0.36.2",
 		"astro": "^5.15.3",
+		"remark-smartypants": "^3.0.2",
 		"sharp": "^0.34.4",
 		"typescript": "^5.9.3"
 	},

src/content/docs/guides/.gitignore

@@ -0,0 +1 @@
+/cli.md

src/content/docs/guides/_cli.md

@@ -0,0 +1,30 @@
+---
+title: Command-Line Flags
+---
+<!--
+The _cli.md file is used as a template to generate the cli.md file
+at build time.
+-->
+
+README-OPTIONS-PLACEHOLDER
+
+## Repeating Options
+
+Some options can be specified multiple times. This is true for:
+
+- `--exclude`
+- `--exclude-path`
+- `--header`
+- `--include`
+- `--remap`
+- `--scheme`
+
+Here is an example:
+
+```bash
+lychee --exclude https://example.com --exclude https://example.org README.md
+```
+
+To specify multiple values in this way, the argument flag should be repeated.
+Otherwise, the extra values would be treated as link checking inputs.
+