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

docs(mdc): fix {attribute} examples #2228

Merged
merged 5 commits into from Aug 23, 2023
Merged

docs(mdc): fix {attribute} examples #2228

merged 5 commits into from Aug 23, 2023

Conversation

nobkd
Copy link
Contributor

@nobkd nobkd commented Aug 15, 2023

πŸ”— Linked issue

❓ Type of change

  • πŸ“– Documentation (updates to the documentation or readme)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • πŸ‘Œ Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

πŸ“š Description

As Tailwind isn't used by Docus anymore, the class names aren't providing styling by themselves. I added the corresponding style tags to fix this.
This has also been changed for lines 347-349 in a previous PR #1982.

I am not sure, if it is good to do this, because the class name styling won't work if someone tries doing it with Docus.
Maybe a warning or info should be added, that the styling with classes just works with e.g. Tailwind?
I mean... the props are assigned, just the styling would be missing.

πŸ“ Checklist

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

@netlify
Copy link

netlify bot commented Aug 15, 2023

βœ… Deploy Preview for nuxt-content ready!

Built without sensitive environment variables

Name Link
πŸ”¨ Latest commit f5a9664
πŸ” Latest deploy log https://app.netlify.com/sites/nuxt-content/deploys/64e365f891392200088cf2db
😎 Deploy Preview https://deploy-preview-2228--nuxt-content.netlify.app
πŸ“± Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@nuxt-studio
Copy link

nuxt-studio bot commented Aug 15, 2023

βœ… Live Preview ready!

Name Edit Preview Latest Commit
content Edit on Studio β†—οΈŽ View Live Preview f5a9664

@nuxt-studio
Copy link

nuxt-studio bot commented Aug 15, 2023

βœ… Live Preview ready!

Name Edit Preview Latest Commit
content Edit on Studio β†—οΈŽ View Live Preview 879db4b

@farnabaz
Copy link
Member

The section is about the inline attributes, so I think it would also make sense that in the code sample, we use style attribute to show the usage, it is not necessary to use classes.

  ```md [Code]
  Hello [World]{style="background-color: var(--color-primary-500)" .custom-class}!
  \```

  ::code-block{label="Preview"}
  Hello [World]{style="background-color: var(--color-primary-500)" .custom-class}!
  ::

@nobkd nobkd changed the title docs: fix mdc class coloring docs(mdc): fix {attribute} examples Aug 21, 2023
@farnabaz farnabaz merged commit 71ed34f into nuxt:main Aug 23, 2023
7 checks passed
@nobkd nobkd deleted the docs/class-coloring branch August 23, 2023 12:00
@farnabaz farnabaz mentioned this pull request Aug 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants