Repository navigation
Releases
v1.0.8
v1.0.7
Performance
- Smaller batch size - Reduced from 50 to 25 files per batch for lower peak memory usage
- Enable garbage collection - Added
--expose-gcto default node options so GC hints between batches actually work
These changes should help complete processing of large documentation sets (600+ files) that were running out of memory.
Related to #1
v1
Rolling release - current: v1.0.8
v1.0.6
Performance
-
Batch processing for large documentation sets - Files are now processed in batches of 50, with a fresh transformer instance created for each batch. This allows garbage collection to reclaim memory between batches, preventing heap exhaustion on large documentation sets (600+ files).
-
Added
cleanup()method for explicit resource release -
GC hints between batches when
--expose-gcis enabled
Previous Fixes (v1.0.3 - v1.0.5)
- Fixed anchor links for multi-block pages
- Fixed self-referential links with filename prefix
- Added explicit JSDOM cleanup
Fixes #1
v1.0.5
Performance
- Improved memory usage for large documentation sets - Added explicit JSDOM cleanup between files by calling
window.close()and clearing internal state. This helps garbage collection when processing large documentation sets (600+ files).
Bug Fixes (from v1.0.3 and v1.0.4)
- Fixed anchor links for multi-block pages - Links to definitions in later code blocks now correctly point to the appropriate block.
- Fixed self-referential links with filename prefix - Agda generates self-referential links with the filename included, which are now correctly handled.
Fixes #1
Note: If you're still experiencing memory issues with very large documentation sets, try increasing the Node.js heap size:
- uses: will-break-it/agda-web-docs-lib@v1
with:
node-options: "--max-old-space-size=8192" # 8GBv1.0.4
Bug Fixes
- Fixed self-referential links with filename prefix - Agda generates self-referential links with the filename (e.g.,
Leios.Linear.html#588instead of just#588). These were incorrectly treated as cross-file references and always pointed to B1. Now correctly detects same-file references regardless of whether the filename is included in the href.
This is a follow-up fix to v1.0.3 which addressed the position-to-block mapping but missed this edge case.
Fixes #1
v1.0.3
Bug Fixes
- Fixed anchor links for multi-block pages - Links to definitions in later code blocks now correctly target the appropriate block (e.g.,
#B2-L3) instead of always defaulting to the first block (#B1-L3). This fixes navigation in literate Agda documentation with multiple code blocks.
Fixes #1
Release 1.0.2
Full Changelog: v1.0.1...v1.0.2
Release 1.0.1
Full Changelog: v0.7.1...v1.0.1