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

feat(v2): editUrl function for advanced use-cases #4121

Merged
merged 4 commits into from
Jan 29, 2021
Merged

Conversation

slorber
Copy link
Collaborator

@slorber slorber commented Jan 28, 2021

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

@netlify
Copy link

netlify bot commented Jan 28, 2021

[V1] Deploy preview success

Built with commit 38d4f02

https://deploy-preview-4121--docusaurus-1.netlify.app

@github-actions
Copy link

github-actions bot commented Jan 28, 2021

Size Change: +3 B (0%)

Total Size: 28.8 kB

ℹ️ View Unchanged
Filename Size Change
website/build/blog/2017/12/14/introducing-docusaurus/index.html 21.8 kB +2 B (0%)
website/build/docs/introduction/index.html 180 B 0 B
website/build/index.html 6.87 kB +1 B (0%)

compressed-size-action

@netlify
Copy link

netlify bot commented Jan 28, 2021

Deploy preview for docusaurus-2 ready!

Built with commit 38d4f02

https://deploy-preview-4121--docusaurus-2.netlify.app

@github-actions
Copy link

github-actions bot commented Jan 28, 2021

⚡️ Lighthouse report for the changes in this PR:

Category Score
🟠 Performance 85
🟢 Accessibility 99
🟢 Best practices 100
🟢 SEO 100
🟢 PWA 95

Lighthouse ran on https://deploy-preview-4121--docusaurus-2.netlify.app/classic/

@slorber slorber merged commit be7b5dc into master Jan 29, 2021
@lex111 lex111 added this to the v2.0.0-alpha.71 milestone Mar 1, 2021
This was referenced Mar 10, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Signed Facebook CLA pr: new feature This PR adds a new API or behavior.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants