Allow user-configurable links in header & sidebar #2078
Merged
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.
Closes #1830
This PR introduces three options;
titleLink
: a string URL that the title links to; defaults to current behaviour of linking to documentation homepagenavigationLinks
: aRecord<string, string>
mapping labels to URLs to include in the headersidebarLinks
: aRecord<string, string>
mapping labels to URLs to include in the sidebarNaming is a bit iffy since the sidebar is internally referred to as navigation, but the label "header" is taken by the title portion of the page so this is the best I could come up with.