Repository navigation
Conversation
✅ Deploy Preview for stackable-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
lfrancke
force-pushed
the
docs/markdown-pages
branch
from
November 19, 2026 23:25
7eefdde to
e446163
Compare
lfrancke
marked this pull request as ready for review
November 19, 2026 23:27
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Publishes a Markdown version of every page that next to its HTML (
index.mdbesideindex.html, as https://llmstxt.org/ proposes), and points the llms.txt entries at those files instead of the HTML.Also adds
/llms-full.txtwith 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-devthen look atbuild/site.That should show all the md files and
llms.txt(with a lot of links) andllms-full.txtAuthor
Reviewer
Acceptance