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): Provide docs plugin theme typing #3328

Merged
merged 1 commit into from
Aug 27, 2020
Merged

feat(v2): Provide docs plugin theme typing #3328

merged 1 commit into from
Aug 27, 2020

Conversation

SamChou19815
Copy link
Contributor

@SamChou19815 SamChou19815 commented Aug 23, 2020

Motivation

Following #3267, this PR adds type definitions for docs plugin.

I moved some type definitions frin docusaurus-plugin-content-docs/src/types.ts into a type-exporting-only dummy module @docusaurus/plugin-content-docs-types in docusaurus-plugin-content-docs/src/plugin-content-docs.d.ts, so that its types can be used by both code in the docs plugin and the module type declaration file. This also allows types defined in @docusaurus/plugin-content-docs-types to be used in theme-classic.

Have you read the Contributing Guidelines on pull requests?

Yes

Test Plan

This PR contains no runtime changes. Check CI to see everything type checks.

Related PRs

(If this PR adds or changes functionality, please take some time to update the docs at https://github.com/facebook/docusaurus, and link to your PR here.)

@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Aug 23, 2020
@docusaurus-bot
Copy link
Contributor

docusaurus-bot commented Aug 23, 2020

Deploy preview for docusaurus-2 ready!

Built with commit 236c792

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

@SamChou19815 SamChou19815 marked this pull request as ready for review August 23, 2020 21:44
@slorber
Copy link
Collaborator

slorber commented Aug 27, 2020

thanks that looks good :)

@slorber slorber added the pr: new feature This PR adds a new API or behavior. label Aug 27, 2020
@slorber slorber merged commit d299b99 into facebook:master Aug 27, 2020
@SamChou19815 SamChou19815 deleted the docs-plugin-typing branch August 27, 2020 13:59
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.

4 participants