Skip to content

feat: generate per-doc markdown files via docusaurus-plugin-llms#82

Open
RicardoStoklosa wants to merge 4 commits into
mainfrom
feat/llms-plugin-md-files
Open

feat: generate per-doc markdown files via docusaurus-plugin-llms#82
RicardoStoklosa wants to merge 4 commits into
mainfrom
feat/llms-plugin-md-files

Conversation

@RicardoStoklosa
Copy link
Copy Markdown
Member

@RicardoStoklosa RicardoStoklosa commented May 26, 2026

Summary

  • Bump docusaurus-plugin-llms from ^0.3.0 to ^0.4.0.
  • Enable generateMarkdownFiles: true so every doc page is emitted as a sibling .md file in the build output (e.g. /tagodeploy/new-project.md).
  • Preserve title and description front matter on the generated files via keepFrontMatter.

The plugin defaults to addMdExtension: true, so llms.txt now links to the .md versions instead of HTML pages. TagoDeploy (and other consumers) can fetch those URLs directly to render the docs as markdown.

Why

TagoDeploy needs the raw markdown of each doc to render help content inside the product. The 0.4.0 release of docusaurus-plugin-llms adds first-class support for emitting per-doc .md files alongside the existing llms.txt / llms-full.txt artifacts.

Risk (CIA)

  • Confidentiality: none. Same content already published as HTML.
  • Integrity: none. Build artifacts only, no source docs touched.
  • Availability: none. Additive output files.

Test plan

  • npm install succeeds with minimal lockfile delta
  • npm run build succeeds
  • 330 .md files generated under build/ matching the docs tree
  • build/llms.txt and build/llms-full.txt still generated
  • Sample build/tagodeploy/new-project.md contains preserved title / description front matter
  • Beta deploy verified: https://docs.beta.tago.io/<path>.md resolves

Bump docusaurus-plugin-llms to 0.4.0 and enable generateMarkdownFiles so
each doc page is exposed as a .md sibling. llms.txt links now point to
those .md URLs (default addMdExtension behavior), which lets TagoDeploy
and other consumers fetch the raw markdown for rendering.

Preserves title and description front matter on generated files.
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.

3 participants