Document per-page locale links feature #2801
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
![tembo[bot]](https://avatars.githubusercontent.com/in/1223475?s=60&v=4){kind=small}
| ### External URLs for language switcher | ||
|
|
||
| For multi-domain documentation setups where different locales are hosted on separate domains, you can configure external URLs in the language switcher. This is useful when not all pages exist in all locales or when you maintain separate documentation sites per region. | ||
|
|
Contributor
There was a problem hiding this comment.
Minor clarity: there are now two different languages arrays (navigation.languages vs navigation.global.languages); calling that out here helps avoid confusion.
Suggested change
| For multi-domain documentation setups where different locales are hosted on separate domains, you can configure external URLs in the language switcher. This is separate from `navigation.languages`, which controls each locale’s navigation structure. |
| Override the default language switcher URLs for specific pages using frontmatter. This allows you to link directly to the translated version of the current page instead of the homepage. | ||
|
|
||
| Add locale-specific links to your page frontmatter using the pattern `{language_code}_link`: | ||
|
|
Contributor
There was a problem hiding this comment.
Worth a quick sentence on the fallback behavior when a {language_code}_link isn’t set for a locale (does it fall back to the locale href from docs.json, or something else?).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Added documentation for the new per-page locale links feature that allows users to override language switcher URLs using frontmatter. This enables multi-domain documentation setups where different locales are hosted on separate domains.
Files changed
guides/internationalization.mdx- Added section on external URLs for language switcher and per-page locale links configurationGenerated from feat: support local-based external urls for language switcher @rtbarnes
Note
Updates internationalization guide with new language switcher configuration options.
navigation.global.languagesindocs.jsonwithhrefanddefaultto point languages to external domains{language_code}_linkfrontmatter to route the switcher to specific translated page URLsWritten by Cursor Bugbot for commit 4c347e4. This will update automatically on new commits. Configure here.