Skip to content

feat: Publish Markdown versions of the docs pages and an llms-full.txt - #984

Open
lfrancke wants to merge 4 commits into
mainfrom
docs/markdown-pages
Open

lfrancke wants to merge 4 commits into
mainfrom
docs/markdown-pages

Conversation

@lfrancke

@lfrancke lfrancke commented Nov 13, 2026 •

Copy link
Copy Markdown
Member

Description

Publishes a Markdown version of every page that next to its HTML (index.md beside index.html, as https://llmstxt.org/ proposes), and points the llms.txt entries at those files instead of the HTML.

Also adds /llms-full.txt with all non-optional pages in one file this is outside the spec but often done. Probably not too useful but also doesn't cost much and shouldn't hurt.

The conversion happens based on the HTML and not the Asciidoc because we have all those includes and references and plugins etc. so looking at a single Asciidoc file doesn't help :(

This uses the libraries turndown (to convert HTML to markdown) including a GFM table plugin (Github flavored markdown). turndown itself uses domino (a DOM thing) to parse the HTML.

Admonitions, callout lists, tabs and Mermaid diagrams get their own rules, links are absolute, and links to other indexed pages point at their Markdown version.

A page can opt out of all of this with :page-llms-ignore:.

Testing

Locally, make ANTORAFLAGS=--fetch build-only-dev then look at build/site.

That should show all the md files and llms.txt (with a lot of links) and llms-full.txt

Author

  • AI review done, findings addressed
  • Tests added or updated

Reviewer

  • Useful comments and logging
  • Docs added or updated per the style guide

Acceptance

  • Check for release notes and docs

@netlify

netlify Bot commented Nov 13, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for stackable-docs ready!

Name Link
🔨 Latest commit e446163
🔍 Latest deploy log https://app.netlify.com/projects/stackable-docs/deploys/6aff8584daea6fe3bbdafb1e
😎 Deploy Preview https://deploy-preview-984--stackable-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@lfrancke
lfrancke force-pushed the docs/markdown-pages branch from 7eefdde to e446163 Compare November 19, 2026 23:25
@lfrancke
lfrancke marked this pull request as ready for review November 19, 2026 23:27
@lfrancke lfrancke self-assigned this Nov 19, 2026
@lfrancke lfrancke moved this to Development: Waiting for Review in Stackable Engineering Nov 19, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Development: Waiting for Review

Development

Successfully merging this pull request may close these issues.

1 participant