Generate config example #128

thomas-zahner · 2025-11-18T14:50:56Z

Thanks to @katrinafyi we now have a way of generating content in the docs from files of the main lychee repository. This is a follow-up PR making the base functionality applicable to other use-cases. Additionally closes lycheeverse/lychee#1768

thomas-zahner · 2025-11-18T14:58:16Z

src/generate/generate.ts

+
+		for (const { placeholder, value } of replacements) {
+			const before = content;
+			content = content.replace(placeholder, () => value);


Something quite interesting I learned is that replace on String knows special values for the replacement value like $'. This caused problems for the config file as replacement value. By using a function instead this weird behaviour is disabled. Average JavaScript developer experience I guess 🤷

That's one for https://github.com/denysdovhan/wtfjs

True haha 😄

src/generate/generate-cli-options.ts

src/generate/generate.ts

katrinafyi

I'm very happy to see the fetching code generalised and reused! Alongside the unit test in the main repo, this is a great improvement for documentation.

src/content/docs/guides/_config.md

astro.config.mjs

thomas-zahner added 3 commits November 18, 2025 11:34

Make content generation ready for other use-cases

304200a

Separate generic genarator from cli option specifics

6c804a4

Fetch example config from main repository

490b694

thomas-zahner commented Nov 18, 2025

View reviewed changes

Update config documentation & extract version note

16acadd

thomas-zahner force-pushed the generate-config-example branch from e8e5f17 to 16acadd Compare November 18, 2025 15:04

thomas-zahner requested a review from mre November 18, 2025 15:04