Skip to content

Add agent-friendly support plan and phase 1 implementation of Markdown output#2597

Merged
chalin merged 30 commits intogoogle:mainfrom
chalin:chalin-m24-md-output-2026-0404
Apr 5, 2026
Merged

Add agent-friendly support plan and phase 1 implementation of Markdown output#2597
chalin merged 30 commits intogoogle:mainfrom
chalin:chalin-m24-md-output-2026-0404

Conversation

@chalin
Copy link
Copy Markdown
Collaborator

@chalin chalin commented Apr 5, 2026

  • Contributes to:
  • Adds task/plan docs for the new feature and its golden-test coverage strategy.
  • Adds experimental opt-in Markdown output support to Docsy via layouts/all.md and a new Markdown output format.
  • Enables Markdown outputs on docsy.dev for home, page, and section; keeps search.md HTML-only.
  • Uses a simple fallback rendering model: title, description blockquote, rendered body content, and section child links.
  • Preserves existing HTML, RSS, and print outputs.
    • Adds golden-based tests for Markdown output
    • Adds docsy.dev Markdown golden tests plus a manifest-driven update script.
    • Wires Markdown golden verification into docsy.dev's npm test.
  • Defers llms.txt, content negotiation, taxonomy/term rollout, and Markdown-specific link rewriting to later phases.

Preview:

Code diffs are only due to new alternate links, and build/page timestamps:

$ (cd public && git diff -bw --ignore-blank-lines -I 'link rel="alternate' -- ':(exclude)*.xml') | grep ^diff       
diff --git a/fr/project/index.html b/fr/project/index.html
diff --git a/fr/search/index.html b/fr/search/index.html
diff --git a/project/index.html b/project/index.html
diff --git a/search/index.html b/search/index.html
$ (cd public && git diff -bw --ignore-blank-lines -I 'link rel="alternate|buildDate|dateModified|modified_time' -- ':(exclude)*.xml')
$ # no output
$ curl -sI https://deploy-preview-2597--docsydocs.netlify.app/index.md
HTTP/2 200 
accept-ranges: bytes
age: 0
cache-control: public,max-age=0,must-revalidate
cache-status: "Netlify Edge"; fwd=miss
content-type: text/markdown; charset=UTF-8

@chalin chalin added this to the 0.15.0 milestone Apr 5, 2026
@chalin chalin added enhancement New feature or request AI labels Apr 5, 2026
@chalin chalin changed the title Add agent-friendly support plan and an implementation of Markdown output Add agent-friendly support plan and phase 1 implementation of Markdown output Apr 5, 2026
@chalin chalin force-pushed the chalin-m24-md-output-2026-0404 branch 4 times, most recently from 9a43da5 to f87e06b Compare April 5, 2026 16:26
@chalin chalin force-pushed the chalin-m24-md-output-2026-0404 branch from f87e06b to a7d7c15 Compare April 5, 2026 16:26
@chalin chalin force-pushed the chalin-m24-md-output-2026-0404 branch from 03d2452 to 19d181e Compare April 5, 2026 16:54
@chalin chalin merged commit 4db086c into google:main Apr 5, 2026
12 checks passed
@chalin chalin deleted the chalin-m24-md-output-2026-0404 branch April 5, 2026 17:08
@chalin chalin mentioned this pull request Apr 5, 2026
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

AI enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant