Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow user-configurable links in header & sidebar #2078

Merged
merged 4 commits into from Oct 18, 2022

Conversation

futurGH
Copy link
Contributor

@futurGH futurGH commented Oct 16, 2022

Closes #1830

This PR introduces three options;

  • titleLink: a string URL that the title links to; defaults to current behaviour of linking to documentation homepage
  • navigationLinks: a Record<string, string> mapping labels to URLs to include in the header
  • sidebarLinks: a Record<string, string> mapping labels to URLs to include in the sidebar

Naming 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.

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Oct 18, 2022

Thanks!

@Gerrit0 Gerrit0 merged commit 2eaa476 into TypeStrong:master Oct 18, 2022
@futurGH futurGH deleted the configurable-links branch October 18, 2022 13:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add GitHub link and/or link to the project site (instead of the typedoc site), to the default theme?
2 participants