Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
5154a81
Add include_versions and all_versions_url kwargs
kdayday Feb 23, 2026
b271803
Draft updated selector
kdayday Feb 25, 2026
57ace77
Update test
kdayday Feb 25, 2026
b79853f
Bug fix see all versions (has Sienna reference)
kdayday Apr 21, 2026
f0914f5
Make names generic and extract js asset
kdayday Apr 21, 2026
e04fb70
Update and add include_versions tests
kdayday Apr 21, 2026
c02e9a9
Add include_versions in readme examples
kdayday Apr 21, 2026
bbd0d66
Run runic
kdayday Apr 22, 2026
31f4b54
Fix broken test with boolean
kdayday Apr 22, 2026
edad44d
Bug fix pagefind for windows 1.6
kdayday Apr 22, 2026
aab1922
bugfix pagefind
kdayday Apr 22, 2026
3f3b559
Fix get_meta_redirect_url UndefVarError when content attribute is mis…
kdayday Jun 16, 2026
f06baa5
Run runic
kdayday Jun 17, 2026
cd01ae5
Clean up include_versions: drop pagefind changes, URL derivation, cli…
pfitzseb Aug 19, 2026
911add4
Drop the generated JS: write the "See All Versions" option at build time
pfitzseb Aug 19, 2026
6f18697
Remove code left over from the earlier include_versions iterations
pfitzseb Aug 19, 2026
37c6127
Fix Windows skip aborting the rest of the include_versions tests
pfitzseb Aug 19, 2026
4dd7ce2
Fix include_versions regressions against main
pfitzseb Aug 19, 2026
bf11f42
Factor version limiting into a VersionSelection struct
pfitzseb Aug 19, 2026
09b2734
Warn about packages that contribute nothing to the search index
pfitzseb Aug 19, 2026
60961c4
Merge branch 'main' into kd/version-reduction
pfitzseb Aug 19, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,34 @@ MultiDocumenter.make(
)
```

### Limiting copied versions and linking to all upstream versions

When aggregating many packages, you can copy only selected deployed versions to reduce storage size of the final website:

```julia
MultiDocumenter.MultiDocRef(
upstream = joinpath(clonedir, "SomePackage"),
path = "SomePackage",
name = "SomePackage.jl",
giturl = "https://github.com/SomeOrg/SomePackage.jl.git",
versions = MultiDocumenter.VersionSelection(
["stable", "dev"];
# optional: adds a "See All Versions" entry to the version selector
all_versions_url = "https://someorg.github.io/SomePackage.jl/",
),
)
```

- Only the listed version directories are copied (plus root files like `index.html` and `versions.js`).
Versions that do not exist upstream are reported and skipped; if none of them exist, all versions are copied.
- The package's `index.html` is regenerated to redirect to the **first** version that was copied, and that
version becomes the canonical one for the package, so list them in the order you want.
- `versions.js` is rewritten to include only copied versions, and Documenter's "outdated version" markers
(`DOCUMENTER_NEWEST`, `DOCUMENTER_STABLE`) are repointed at versions that were copied.
- If `all_versions_url` is set, the version selector gets a `See All Versions` entry pointing there, so that
the versions that were not copied stay reachable on the upstream site. It must be an absolute `http(s)` URL
naming the site root, and is not derived from `giturl`.

![example](sample.png)

## Deployment
Expand Down
Loading