search

wallpants / pantsdown

Markdown to "GitHub HTML" parser
https://wallpants.github.io/pantsdown/
Other
4 stars 1 forks source link

Add TIP and CAUTION alerts #180

Closed froi closed 6 months ago

froi commented 6 months ago

This PR adds support for two additional GitHub alerts: TIP and CAUTION. This makes this project at par with the current GitHub alerts.

What changed

Rendered demo

supported alerts

Closes #179

wallpants commented 6 months ago

LGTM! 🚀

I believe you took the screenshot before you fixed the color for the TIP alert. The code shows the alert as color success, but the screenshot shows it as accent.

I'm sorry that I haven't added contributing docs to this repo. The contributing section in github-preview.nvim's docs applies to this repo (except for the tailwind part).

Basically run:

bun run format
bun run lint

to make sure that code is formatted and there are no linting issues and then squash all your commits into a single commit with a title that follows the Conventional Commits format.

It could be something like:

feat: add TIP and CAUTION alerts

Thank you for taking the time to contribute to this project 😃

I'll make sure to add contributing docs as soon as we get this PR merged.

github-actions[bot] commented 6 months ago

:tada: This issue has been resolved in version 2.1.0 :tada:

The release is available on:

Your semantic-release bot :package::rocket:

wallpants commented 6 months ago

I created a new PR #184 with your changes to pass the github action validations.

Thank you @froi

froi commented 6 months ago

@wallpants

I believe you took the screenshot before you fixed the color for the TIP alert. The code shows the alert as color success, but the screenshot shows it as accent.

Yep! 🤦🏼

I'm sorry that I haven't added contributing docs to this repo. The contributing section in github-preview.nvim's docs applies to this repo (except for the tailwind part).

Basically run:

bun run format
bun run lint

to make sure that code is formatted and there are no linting issues and then squash all your commits into a single commit with a title that follows the Conventional Commits format.

It could be something like:

feat: add TIP and CAUTION alerts

Thank you for taking the time to contribute to this project 😃

I'll make sure to add contributing docs as soon as we get this PR merged.

Not a problem, it was my pleasure, and thanks for the work and explanation!