Skip to content

feat(site): negotiate markdown docs - #1779

Merged
chaliy merged 1 commit into
mainfrom
2026-05-26-markdown-content-negotiation
May 26, 2026
Merged

chaliy merged 1 commit into
mainfrom
2026-05-26-markdown-content-negotiation

Conversation

@chaliy

@chaliy chaliy commented May 26, 2026

Copy link
Copy Markdown
Contributor

What

Add negotiated Markdown representations for Bashkit docs pages.

Why

Docs should be readable by clients that explicitly prefer text/markdown without changing the default browser HTML experience.

How

  • Generate /docs.md and /docs/<slug>.md static Markdown assets from the existing curated docs metadata and canonical source markdown.
  • Add a Cloudflare Worker that serves Markdown for docs URLs only when Accept explicitly prefers text/markdown, with Vary: Accept for cache correctness.
  • Add YAML front matter and generated navigation to negotiated Markdown docs.
  • Extend postbuild verification for generated Markdown routes, negotiation helpers, and Markdown docs discovery headers.

Risk

  • Low
  • Docs routes could serve the wrong representation if Worker routing or Accept parsing regresses; postbuild and Wrangler smoke coverage guard this.

Checklist

  • Tests added or updated
  • Backward compatibility considered

@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs
bashkit 8cf8b77 Commit Preview URL May 26 2026, 04:26 AM

@chaliy
chaliy merged commit a2d2110 into main May 26, 2026
19 checks passed
@chaliy
chaliy deleted the 2026-05-26-markdown-content-negotiation branch May 26, 2026 04:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant