refactor(v2): extract site title formatter to theme-common util#3838
Merged
slorber merged 1 commit intofacebook:masterfrom Nov 30, 2020
Merged
refactor(v2): extract site title formatter to theme-common util#3838slorber merged 1 commit intofacebook:masterfrom
slorber merged 1 commit intofacebook:masterfrom
Conversation
|
Deploy preview for docusaurus-2 ready! Built without sensitive environment variables with commit d9d651c |
Collaborator
|
Thanks, that does not seem like a big issue to me. CF the updated theme doc: https://v2.docusaurus.io/docs/api/themes "main themes" depends on docs,blog, pages, but algolia search is a "theme enhancer" that improves one main theme, so it's not a big deal if it depends on the same things |
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
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
Currently the same function, same formatter is used in various packages to format the
siteTitle.This PR extracts the formatter function to stand alone hook (
useTitleFormatter) and moves it totheme-commonpackage.@slorber My only concern is that after refactor I had to add
@docusaurus/theme-commonalso todocusaurus-theme-search-algoliadependencies. In theory this is the expected thattheme-searchcan be depended ontheme-common, but due to the way intheme-commondependencies have been declared, this will mean that Algolia plugin now will fetch all content plugins (https://github.com/facebook/docusaurus/blob/master/packages/docusaurus-theme-common/package.json#L20).Not sure how big problem it is in the general scope of Docusuasaurs, since this package should not be used without Docusuaurs, but maybe there is a better way to define/setup this. Maybe
theme-commonshould only specifypeerDependencies?Have you read the Contributing Guidelines on pull requests?
Yes.
Test Plan
Changes have been tested using Docusuaurs V2 website locally.
Related PRs