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): ignore imports when h1 heading parsing #4646

Merged
merged 1 commit into from
Apr 20, 2021
Merged

Conversation

lex111
Copy link
Contributor

@lex111 lex111 commented Apr 19, 2021

Motivation

Resolves #4635.

Have you read the Contributing Guidelines on pull requests?

Yes

Test Plan

Suppose we have following doc:

---
id: test
---

import BrowserWindow from '@site/src/components/BrowserWindow';

# Title

## Second heading

Results:

Before After
image image

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 Apr 19, 2021
@lex111 lex111 requested a review from slorber as a code owner April 19, 2021 17:11
@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Apr 19, 2021
@netlify
Copy link

netlify bot commented Apr 19, 2021

[V1]

Built with commit 2d52db4

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

@netlify
Copy link

netlify bot commented Apr 19, 2021

[V2]

Built with commit 2d52db4

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

@github-actions
Copy link

⚡️ Lighthouse report for the changes in this PR:

Category Score
🟠 Performance 78
🟢 Accessibility 96
🟢 Best practices 100
🟢 SEO 100
🟢 PWA 95

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

@github-actions
Copy link

Size Change: 0 B

Total Size: 630 kB

ℹ️ View Unchanged
Filename Size Change
website/build/assets/css/styles.********.css 87.5 kB 0 B
website/build/assets/js/main.********.js 453 kB 0 B
website/build/blog/2017/12/14/introducing-docusaurus/index.html 62.3 kB 0 B
website/build/docs/introduction/index.html 235 B 0 B
website/build/index.html 27.1 kB 0 B

compressed-size-action

@slorber
Copy link
Collaborator

slorber commented Apr 20, 2021

Thanks, not sure it will handle all the edge cases but should be good enough for now.

We should probably ignore exports too and can maybe reuse the regexp from createExcerpt for that.

But supporting multiline exports (like a React comp declared at the top of a MDX file) can be complicated (ex: https://dev.to/sebastienlorber/using-react-hooks-in-mdx-4ei6). Maybe not worth to solve this for now.

@slorber slorber merged commit 4835222 into master Apr 20, 2021
@slorber slorber deleted the lex111/iss4635 branch August 17, 2021 18:02
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.

Allow MDX imports to be above h1 heading
3 participants