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): improve templates, use JSDoc type annotation, improve docusaurus.config.js autocompletion #4098

Merged
merged 1 commit into from
Jan 27, 2021

Conversation

neo-sam
Copy link
Contributor

@neo-sam neo-sam commented Jan 25, 2021

Motivation

Better type hints and smart complement for docusaurus.config.js using jsdoc.

Have you read the Contributing Guidelines on pull requests?

Yes

Test Plan

Worked nice in vscode!

2021-01-24_21-55-50.mp4

Related PRs

NONE

@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Jan 25, 2021
@netlify
Copy link

netlify bot commented Jan 25, 2021

@github-actions
Copy link

github-actions bot commented Jan 25, 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.7 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 25, 2021

Deploy preview for docusaurus-2 ready!

Built without sensitive environment variables with commit 04143d1

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

@github-actions
Copy link

github-actions bot commented Jan 25, 2021

⚡️ Lighthouse report for the changes in this PR:

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

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

@RDIL
Copy link
Contributor

RDIL commented Jan 25, 2021

Please also add it to the templates, located here.

@neo-sam
Copy link
Contributor Author

neo-sam commented Jan 26, 2021

@RDIL okay!

@slorber slorber added the pr: new feature This PR adds a new API or behavior. label Jan 27, 2021
@slorber
Copy link
Collaborator

slorber commented Jan 27, 2021

thanks, that looks like a convenient improvement without forcing users to adopt TypeScript 👍

@slorber slorber changed the title Better smart complement for docusaurus.config.js using jsdoc feat(v2): improve templates, use JSDoc type annotation, improve docusaurus.config.js autocompletion Jan 27, 2021
@slorber slorber merged commit 22e2319 into facebook:master Jan 27, 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.

5 participants