doczjs / docz

✍ It has never been so easy to document your things!
https://docz.site
MIT License
23.61k stars 1.46k forks source link

heading styles are not applied as intended #1679

Open georg94 opened 2 years ago

georg94 commented 2 years ago

In a docz project I tried to change some styles and encountered some buggy behavior of the theme. The current theme already applies styles to headings

https://github.com/doczjs/docz/blob/main/core/gatsby-theme-docz/src/theme/styles.js

{
// ...
h1: {
    fontSize: 6,
  },
  h2: {
    fontSize: 5,
  },
  h3: {
    fontSize: 4,
  },
  h4: {
    fontSize: 3,
  },
  h5: {
    fontSize: 2,
  },
  h6: {
    fontSize: 1,
  },
// ...
}

These styles are not applied to the heading tags in the DOM (no class is appended).

I debugged this issue and found this commit https://github.com/doczjs/docz/commit/a9384b03cbd316c37a156536fac6a6f206260d2e.

Removing the MDXProvider from the Layout fixes the issue, but I don't know if it breaks something else. In my project everything is still working (and the styles are applied).