feat(v2): useDocusaurusContext().siteMetadata #3058
Merged
Conversation
This file contains 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
slorber
commented
Jul 14, 2020
| isClient?: boolean; | ||
| siteConfig: DocusaurusConfig; | ||
| siteMetadata: DocusaurusSiteMetadata; | ||
| isClient: boolean; | ||
| } |
There was a problem hiding this comment.
removed the ? here, we shouldn't use the hook and retrieve a partial context, we should fail fast instead.
|
Deploy preview for docusaurus-2 ready! Built with commit b05bc79 |
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
Expose siteMetadata in
useDocusaurusContext()hookAlgolia devs need access docusaurus version, and we should rather advise to use the hook instead of importing a static generated file (makes comp testing easier by using a provider)
See also:
@SamChou19815 I moved a bit the type declaration to match what we currently have for siteConfig type declaration and be uniform.
Not totally sure yet what's the impact of declaring types in one or the other of
@docusaurus/typesvsdocusaurus-module-type-aliases