Skip to content

docs: using markdown in component slots (docs #2401) #2402

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

docs: using markdown in component slots (docs #2401) #2402

wants to merge 2 commits into from

Conversation

petedavisdev
Copy link

Summary

Documentation on how to use markdown in component slots with:

  • code examples for single slot and named slots with empty lines before and after markdown,
  • warning about not using # shorthand for named slots.

This is an awesome feature that deserves to be documented so that people know it's available and understand how to use it correctly.

What kind of change does this PR introduce? (check at least one)

  • Bugfix
  • Feature
  • Code style update
  • Refactor
  • Docs
  • Build-related changes
  • Other, please describe:

If changing the UI of default theme, please provide the before/after screenshot:

Does this PR introduce a breaking change? (check one)

  • Yes
  • No

If yes, please describe the impact and migration path for existing applications:

The PR fulfills these requirements:

  • When resolving a specific issue, it's referenced in the PR's title (e.g. fix #xxx[,#xxx], where "xxx" is the issue number)

You have tested in the following browsers: (Providing a detailed version will be better.)

  • Chrome
  • Firefox
  • Safari
  • Edge
  • IE

If adding a new feature, the PR's description includes:

  • A convincing reason for adding this feature
  • Related documents have been updated
  • Related tests have been updated

To avoid wasting your time, it's best to open a feature request issue first and wait for approval before working on it.

Other information:

@petedavisdev petedavisdev changed the title docs #2401: using markdown in component slots docs: #2401 using markdown in component slots May 23, 2020
@petedavisdev petedavisdev changed the title docs: #2401 using markdown in component slots docs: using markdown in component slots (docs: #2401) May 23, 2020
@petedavisdev petedavisdev changed the title docs: using markdown in component slots (docs: #2401) docs: using markdown in component slots (docs #2401) May 23, 2020
@petedavisdev
Copy link
Author

@Matthew-Benson
Copy link

Any update on this? I wanted to render markdown in a component and read through docs and issues for an hour before stumbling on this PR. Would have been very helpful to find this information quickly.

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.

3 participants