feat: relative links, TOC generation, and link validation #1
Conversation
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
Fix <base href="/"> issue where #anchor links navigate to /#anchor. The build now transforms relative links to absolute paths: - #section → /blog/slug#section - ../other-slug → /blog/other-slug - ../other-slug#section → /blog/other-slug#section Uses path.posix.resolve() for cross-platform path resolution. linkBasePath is derived from folder structure (folder = URL path). Also fixes: mailto:, tel:, ftp:// links are now correctly preserved (isAbsoluteUrl uses /^\w+:/ regex to match all protocols). Includes comprehensive documentation of URL transformation system.
- Add TOC_MARKER constant for [[toc]] placeholder - Add generateToc() using getHeadingList() from marked-gfm-heading-id - Add decodeHtmlEntities() for proper heading text display - Include h2 and h3 headings, skip headings before marker - Generate nested markdown list that gets processed normally Also includes: - Tests for mailto:, tel:, ftp:// links (not transformed) - Tests for TOC generation (6 new tests)
- Add HeadingData, getHeadingList, and resetHeadings exports to types.d.ts - Add missing linkBasePath parameter to markdownToEntry test calls
- Document image URL transformation (placeholder system) - Document link transformation (relative to absolute) - Document TOC generation with [[toc]] marker - Add YAML frontmatter reference - Add architecture overview - Add submodule warning
- Fork marked-gfm-heading-id to shared/gfm-heading-id/ - Convert to TypeScript with improved types - Simplified API (removed unused globalSlugs option) - Better entity handling (decode before slugging) - Replace marked-gfm-heading-id dependency with github-slugger - Remove now-empty types.d.ts - Update README with github-slugger reference The fork is only 100 lines and gives us full control over heading ID generation. All 131 tests pass.
- Remove decodeHtmlEntities() from JekyllMarkdownParser (now in fork) - Use h.raw directly instead of decoding h.text - Update comment to reference our gfm-heading-id fork The fork provides heading.raw which is already decoded and stripped of HTML tags, eliminating duplicate code.
Code Quality Improvements: - Extract shared utilities to html.utils.ts (stripHtmlTags, decodeHtmlEntities, escapeHtml) - Precompile regex patterns for better performance - Simplify parse() return type (remove unused yaml/markdown fields) - Update documentation to reference our gfm-heading-id fork TOC Generation Simplification: - Replace complex position-tracking algorithm with simple split approach - Split markdown at [[toc]] marker, parse only content after it - Reduces generateToc from 60+ lines to 30 lines - More robust: no regex matching of heading text needed Net result: -40 lines of code, cleaner architecture, same functionality. All 131 tests pass.
- TOC links now preserve inline formatting (<code>, <strong>, <em>) - Add warning for duplicate headings (known limitation) - Move gfm-heading-id.ts out of subdirectory - Add html.utils.spec.ts (45 tests) - Add gfm-heading-id.spec.ts (24 tests) - Add 5 TOC formatting tests - Document HeadingData text vs raw separation - Clarify slug terminology in base.types.ts Total: 205 tests passing
Build-time validation for broken anchor links: - Collects all heading IDs during parsing - Extracts all anchor links from HTML - Validates links point to existing anchors - Suggests similar anchors using Levenshtein distance (typo detection) - Warnings only, does not fail the build New files: - string.utils.ts: Levenshtein distance + findSimilar (27 tests) - link-validator.ts: Anchor validation logic (14 tests) Changes: - jekyll-markdown-parser.ts: Now returns headingIds - base.utils.ts: Registers anchors and links during parsing - build.ts: Runs validation at end of build Total: 246 tests passing
fmalcher
reviewed
Feb 8, 2026
fmalcher
approved these changes
Feb 8, 2026
Member
fmalcher
left a comment
fmalcher
left a comment
There was a problem hiding this comment.
Cool! Levenshtein-Distanz ist ein BISSCHEN über's Ziel hinausgeschossen, aber ist geil 😂
- link-validator: use matchAll() instead of exec() loop with global regex - html.utils: add single quote escaping for complete HTML safety - base.utils: replace string concat sort key with proper multi-field comparison
Member
Author
Wenn's das Feature for free kommt! 🤷 |
d-koppenhagen
approved these changes
Feb 8, 2026
fmalcher
approved these changes
Feb 8, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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
Markdown-Dateien können jetzt portable relative Links verwenden. Der Build transformiert diese zu absoluten Pfaden für die Angular-Website.
Relative Links → Absolute Pfade
wird zu:
Automatische TOC-Generierung
[[toc]]im Markdown wird durch ein generiertes Inhaltsverzeichnis ersetzt. Inline-Formatierung bleibt erhalten:## Using `npm install`erscheint im TOC als:
Using <code>npm install</code>Link-Validierung beim Build
Nach dem Build werden alle Anchor-Links geprüft. Bei kaputten Links gibt es Warnungen mit Korrekturvorschlägen (Levenshtein-Distanz):
Sonstiges
marked-gfm-heading-iddurch eigenen Fork ersetzt (mehr Kontrolle über Heading-Daten)html.utils.ts,string.utils.ts