feat(v2): editUrl function for advanced use-cases#4121
Merged
Conversation
This was referenced Jan 28, 2021
|
[V1] Deploy preview success Built with commit 38d4f02 |
|
Size Change: +3 B (0%) Total Size: 28.8 kB ℹ️ View Unchanged
|
|
Deploy preview for docusaurus-2 ready! Built with commit 38d4f02 |
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-4121--docusaurus-2.netlify.app/classic/ |
This was referenced Mar 10, 2021
Closed
Closed
Closed
Closed
This was referenced Mar 12, 2021
Merged
Merged
Closed
mrizwanashiq
pushed a commit
to mrizwanashiq/docusaurus
that referenced
this pull request
Jun 25, 2026
* EditUrl function * normalize blog/docs regarding the editUrl feature + editUrl function * editUrl fn => always inject posix style relative paths, make tests more reliable (see also facebook#4124) * fix editUrl on windows
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Motivation
#3152
Some users are assembling Docusaurus sites from docs coming from multiple places, and the url to edit the doc in the upstream doc referential is not necessarily an url that docusaurus is able to compute based on the files it sees on the filesystem.
Also, we need the ability to customize the editUrl per locale. This allows to link to a specific translation system (like Crowdin) for a subset of locales for example, or having one git repo per locale and using git submodules for assembling the final localized site etc...
A functional form of editUrl gives full power to the user
Have you read the Contributing Guidelines on pull requests?
yes
Test Plan
tests + dogfooding