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

@theme-ui/prism README improvements #2378

Open
deepsheth opened this issue Dec 19, 2022 · 0 comments
Open

@theme-ui/prism README improvements #2378

deepsheth opened this issue Dec 19, 2022 · 0 comments
Labels
documentation Changes only affect the documentation

Comments

@deepsheth
Copy link

Is your feature request related to a problem? Please describe.
On the @theme-ui/prism docs, the Highlight section is a little hard to follow considering:

  1. the code block adds the // highlight-line tag in the code, which is then trimmed by the ThemeUIPrism component, but the background is not highlighted in the docs. Likewise for the mulit-line highlight (see the first screenshot).
  2. The presets directory has more themes than what the docs list. Maybe that should be pointed out or the list should be updated?

Describe the solution you'd like

  • For the Highlight docs, I think it's easier to read the prism/README.md on Github which preserves the highlight- comments
  • Since the .highlighted class is added to highlighted lines, we could add that class to the doc's theme file to match what the docs say:

The highlight styling is controlled in styles.pre under .highlight. For example:
".highlight": {
"background": "hsla(0, 0%, 30%, .5)"
}

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context

Current image
Styling .highlight class with a background image
GitHub docs image
@lachlanjc lachlanjc added the documentation Changes only affect the documentation label Dec 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Changes only affect the documentation
Projects
None yet
Development

No branches or pull requests

2 participants