Skip to content

Adding a supplementary explanation component with Markdown component #274

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

Merged
merged 10 commits into from
Nov 23, 2023

Conversation

ShionTerunaga
Copy link
Contributor

@ShionTerunaga ShionTerunaga commented Nov 21, 2023

Closes #257

Description

I want to be able to use a component that displays supplementary explanations using the Markdown component props remarkPlugin.

New behavior

When write note in Markdown component, can express a supplementary explanation using Yamada UI Alert component.

Is this a breaking change (Yes/No):

No

Additional Information

Copy link

changeset-bot bot commented Nov 21, 2023

🦋 Changeset detected

Latest commit: 2131788

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@yamada-ui/markdown Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@hirotomoyamada hirotomoyamada changed the title Draft feat: reinforced markdown along the way Draft: feat: reinforced markdown along the way Nov 21, 2023
@ShionTerunaga ShionTerunaga changed the title Draft: feat: reinforced markdown along the way Adding a supplementary explanation component with Markdown component Nov 22, 2023
@hirotomoyamada hirotomoyamada self-assigned this Nov 22, 2023
Copy link
Member

@illionillion illionillion left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

noteの後にinfowarnなどを記述した場合、変換して表示するAlertコンポーネントのスタイルとアイコンを条件分岐した方が良いと思うので修正お願いしたいです。

https://qiita.com/Qiita/items/c686397e4a0f4f11683d#note---%E8%A3%9C%E8%B6%B3%E8%AA%AC%E6%98%8E

このようになります。

:::note info
インフォメーション
infoは省略可能です。
:::

:::note warn
インフォメーション
infoは省略可能です。
:::

:::note alert
インフォメーション
infoは省略可能です。
:::

image

条件分岐させるスタイルについてはAlertのStorybookを参考にしてください。

@hirotomoyamada
Copy link
Member

@teru12012000 新しい機能をStoryで追加してほしいです。

@hirotomoyamada hirotomoyamada merged commit dd0a23e into yamada-ui:main Nov 23, 2023
@github-actions github-actions bot mentioned this pull request Nov 23, 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.

Adding a supplementary explanation component with Markdown component
3 participants