feat: add --url-path-pattern flag for llms.txt .md link mapping - #101
Merged
Conversation
afdocs assumed clean URLs when deriving page URLs from llms.txt .md links, stripping the extension (/guide.md -> /guide). Sites that serve real filenames expect /guide.html, so the derived URL could 404 or redirect and skew results in ways a real agent wouldn't hit. Add a urlPathPattern option (--url-path-pattern, or urlPathPattern in config) with three values: clean (default, strip extension), html (replace with .html, without doubling .html.md links), and md (keep the .md URL as the canonical page URL). The pattern threads through llms.txt link normalization and every check that converts .md URLs to page URLs. Closes #95
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
1 participant
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.
Summary
urlPathPatternoption (--url-path-patternCLI flag,options.urlPathPatternin config) controlling how llms.txt.mdlinks map to the site's page URLs:clean(default): strip the extension (/guide.md→/guide), the existing behaviorhtml: replace the extension (/guide.md→/guide.html) for sites that serve real filenames;.html.mdlinks don't get doubledmd: keep the.mdURL as the canonical page URL for sites that serve markdown directlyextractLinksFromLlmsTxtFiles) and every check that converts.mdURLs to page URLs (llms-txt-directive-html,llms-txt-directive-md,content-negotiation,markdown-content-parity)Closes #95
Test plan
toHtmlUrlunderhtmlandmdpatterns (including the.html.mdnon-doubling case).mdlinks resolve to.htmlpage URLs / stay.mdper patternnpm test(1310 tests),npm run lint, prettier clean