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

fix(v2): fix warning and improve styling inline TOC #4163

Merged
merged 1 commit into from
Feb 3, 2021

Conversation

lex111
Copy link
Contributor

@lex111 lex111 commented Feb 3, 2021

Motivation

Currently, when going on Configuration page in dv mode, we get a couple of warnings:

Warning: validateDOMNesting(...): <ul> cannot appear as a descendant of <p>.
Warning: validateDOMNesting(...): <div> cannot appear as a descendant of <p>.

This is because only inline elements should be inside the p tag. Unfortunately, this cannot be solved by anything other than placing the TOCInline component on a new line.

I also decided to restyle the inline TOC as a regular list because it doesn't look very good right now.

Before After
image image

Have you read the Contributing Guidelines on pull requests?

Yes

Test Plan

Preview.

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.)

@lex111 lex111 added the pr: bug fix This PR fixes a bug in a past release. label Feb 3, 2021
@lex111 lex111 requested a review from slorber as a code owner February 3, 2021 10:14
@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Feb 3, 2021
@netlify
Copy link

netlify bot commented Feb 3, 2021

[V1] Deploy preview success

Built with commit c59b149

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

@netlify
Copy link

netlify bot commented Feb 3, 2021

Deploy preview for docusaurus-2 ready!

Built with commit c59b149

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

@github-actions
Copy link

github-actions bot commented Feb 3, 2021

⚡️ Lighthouse report for the changes in this PR:

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

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

@github-actions
Copy link

github-actions bot commented Feb 3, 2021

Size Change: +15 B (0%)

Total Size: 156 kB

ℹ️ View Unchanged
Filename Size Change
website/build/assets/css/styles.********.css 17.7 kB 0 B
website/build/assets/js/main.********.js 109 kB +14 B (0%)
website/build/blog/2017/12/14/introducing-docusaurus/index.html 21.7 kB +1 B (0%)
website/build/docs/introduction/index.html 180 B 0 B
website/build/index.html 6.96 kB 0 B

compressed-size-action

@slorber
Copy link
Collaborator

slorber commented Feb 3, 2021

thanks, looks better

@slorber slorber merged commit d25e0f4 into master Feb 3, 2021
@lex111 lex111 deleted the lex111/fix-toc-inline branch February 19, 2021 18:20
@lex111 lex111 added this to the v2.0.0-alpha.71 milestone Mar 1, 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: bug fix This PR fixes a bug in a past release.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants