docs(site): replace starter README and title synopsis fences

Swap the Starlight scaffold README for one describing this project's
two-source SSOT and dev/deploy workflow. Give the generated function
synopsis fence a Starlight filename title (`fish title="name.fish"`)
so it reads as a snippet of the function it documents.
This commit is contained in:
2026-07-26 05:01:01 -04:00
parent 4197e7faec
commit e20cff41d4
3 changed files with 33 additions and 42 deletions
+5 -1
View File
@@ -288,7 +288,11 @@ def _prettify_block(block: list[str], entry_name: str | None) -> str:
# keep the whole thing in one fence rather than orphaning the rest.
while lines and lines[0].startswith(" "):
synopsis.append(lines.pop(0).strip())
out.append("```fish\n" + "\n".join(synopsis) + "\n```")
# Titling the fence with the source file name (Starlight's
# filename-title convention) makes the synopsis read as a snippet
# of the function it documents rather than a bare command example.
info = f'fish title="{entry_name}.fish"' if entry_name else "fish"
out.append(f"```{info}\n" + "\n".join(synopsis) + "\n```")
para: list[str] = []
for line in lines + [""]: