Custom sort for autogenerated groups

[jiv-ropo]

What version of starlight are you using?

0.34.4

What is your idea?

Allow a custom sort function for autogenerated groups.

Why is this feature necessary?

We have numbered page slugs like: ID-1, ID-2, ID-3... This works fine until I hit ID-10 and the ordering will be: ID-1, ID-10, ID-2...

I can add this to the frontmatter of each page:

sidebar:
    order: <index-number>

This is not preferable, because we need to update the slug and the order value separately.

I tried to add the order value logic to the frontmatter via RemarkPlugin and routeMiddleware. This didn't work because the navigation system seems to read the frontmatter before the RemarkPlugin or routeMiddleware.

Suggestions:

1. Allow overriding the frontmatter before the sort function.
2. Have an option in the starlight config to write a custom implementation of node_modules/@astrojs/starlight/utils/navigation.ts -> sortDirEntries().

I like option 1 more as it seems more flexible. I don't know if it's technically feasible.

Do you have examples of this feature in other projects?

No response

Participation

• I am willing to submit a pull request for this feature.