sebnitu / vrembem / 25709394900

90%

main: 100%

push

github

Build new navigation module for rendering drawer sidebar navigation  (#2809)

This PR is a complete re-write of the navigation output in the drawer sidebar. Inspired by Astro's Starlight theme, we now render the sidebar navigation using the new `navigation` module that builds a full navigation tree using an intuitive nav config which allows for setting links, groups of links and auto generating links from a collection. Collections can also be provided filter, sort and directory logic to further customize how the navigation is built and rendered.

- Modules collection has been removed in favor of a single packages collection where modules are just represented by the file system.
- Collection sorting has been refactored by allowing comparators to be chained using the new `sortBy` function. This is used internally so that a collection can be provided a comparator or an array of comparators to sort collections by.
- The logic of pagination navigation has been updated to now be built using the navigation module. When `buildNaviFromConfig` is called, it also returns a `prev` and `next` objects for rendering those entries.

**Additional changes**

- `docs`: Add drawer script to the drawer component file.
- `docs`: Update order properties and documentation structure for some pages.
- `docs`: Move currentPage script from modules into helpers.
- `core`: The `localStore` module has been refactored to `storage` and allows switching between the browser's `localStorage` or `sessionStorage` APIs.

569 of 651 branches covered (87.4%)

Branch coverage included in aggregate %.

5 of 5 new or added lines in 3 files covered. (100.0%)

887 of 953 relevant lines covered (93.07%)

32.05 hits per line