Skip to content

v1.1.0

Latest

Choose a tag to compare

@mensfeld mensfeld released this 02 Nov 10:03
· 12 commits to master since this release
ec7095c
  • [Enhancement] Relative Link Resolution - base_url link expansion now resolves relative links like a browser would.
    • ../ and ./ segments are normalized (../other.md → https://example.com/other.md instead of https://example.com/docs/../other.md).
    • bulk-transform resolves each link from its file's own directory, so ./setup.md in guides/intro.md expands to <base_url>/guides/setup.md.
    • Links starting with / resolve from base_url; anchors, query strings, absolute URLs and mailto:/tel:/ftp: links are unchanged.
  • [Fix] llms.txt Paths Are Percent-Encoded - generate now percent-encodes each path segment in llms.txt entries, with and without base_url.
    • docs/my docs/a b.md gives my%20docs/a%20b.md, so names with spaces or parentheses no longer break the Markdown link.
    • Non-ASCII names are encoded as UTF-8 (zażółć.md → za%C5%BC%C3%B3%C5%82%C4%87.md).
  • [Fix] llms.txt Descriptions - A page description is now always a single line, and the 200-character limit no longer cuts a Markdown link or image in half; a link or image that does not fit is left out.
  • [Fix] Transformed Files Picked Up as Sources - bulk-transform and generate now skip files ending with the transform suffix (*.llm.md by default, or *<suffix>.md).
    • A second bulk-transform run no longer writes *.llm.llm.md files.
    • generate lists each page once, from its source file, instead of listing both README.md and README.llm.md.
    • Source files whose names end with the suffix (e.g. notes.llm.md) are skipped too. An empty suffix skips nothing.
  • [Fix] Angle-Bracket Link Destinations - base_url link expansion now resolves CommonMark [text](<path with spaces>) links like other relative links: the brackets are dropped and spaces are percent-encoded (<../my docs/a b.md> → <base_url>/my%20docs/a%20b.md) instead of producing a broken URL with a stray >.
  • [Fix] Query-Only Links - base_url link expansion now resolves a query-only link like [q](?tab=2) to the current page (guides/sub/page.md gives <base_url>/guides/sub/page.md?tab=2, as RFC 3986 does) instead of the page's directory (<base_url>/guides/sub/?tab=2). Anchor-only links like #self are unchanged.
  • [Fix] simplify_links Strips Only One Prefix - repeated filler prefixes are now all removed, so Click here to see the docs becomes docs (as documented) instead of see the.
  • [Fix] Links Inside Code Are Rewritten - link transformations (base_url expansion, convert_urls, simplify_links) no longer change links in fenced code blocks, indented code blocks and inline code spans.
  • [Fix] convert_urls Skips Anchors, Queries and Relative Links - .html/.htm URLs followed by an anchor or a query are now converted (doc.html#sec → doc.md#sec, doc.html?x=1 → doc.md?x=1).
    • Relative link targets are converted too, also without base_url ([Intro](../intro.html) → [Intro](../intro.md)).
    • .html inside a query or an anchor and targets with a non-HTTP scheme (mailto:, ftp:, sftp:, file:, ...) are left unchanged.
  • [Fix] Links With Brackets in Their Text - base_url link expansion now expands links whose text holds brackets, nested up to two levels deep ([a [b] c](../intro.md)), and linked images like [![alt](../img/a.png)](../intro.md), where both the image and the outer link are now expanded. Before, such links stayed relative, and a linked image got only its image expanded.
  • [Fix] Links With Any URI Scheme - base_url link expansion now leaves every link with a URI scheme unchanged, in any case (HTTPS://, Mailto:, sftp:, ssh:, git:, irc:, urn:, data:, javascript:, ...). Before, only lowercase http, https, mailto, ftp and tel links were kept, and others became broken URLs like <base_url>/guides/sftp:/host/x.
  • [Fix] Link Reference Definitions - base_url link expansion now expands reference-style link definitions ([id]: ../intro.md "Title") like inline links, so [text][id], [id][] and [id] links no longer stay relative while inline links in the same file are expanded. Titles are kept; definitions with a URI scheme, anchors, footnotes ([^1]: ...) and definitions in code are unchanged.
    • convert_urls converts .html/.htm definition targets too ([id]: ../intro.html → [id]: ../intro.md).
  • [Fix] compare Web Server Link - The "Configure your web server" link in the compare output now points at the README section "Serving Optimized Docs to AI Bots" (#serving-optimized-docs-to-ai-bots) instead of a missing #serving-optimized-docs anchor.