search

fuxingloh / contented

Contented is a Markdown-based authoring workflow & processor that encourage developer authoring within its contextual Git repository.
https://contented.fuxing.dev
MIT License
52 stars 2 forks source link

adopt alerts in GitHub Flavored Markdown #613

Open fuxingloh opened 1 year ago

fuxingloh commented 1 year ago

[!NOTE] Highlights information that users should take into account, even when skimming.

[!IMPORTANT] Crucial information necessary for users to succeed.

[!WARNING] Critical content demanding immediate user attention due to potential risks.

> [!NOTE]
> Highlights information that users should take into account, even when skimming.

> [!IMPORTANT]
> Crucial information necessary for users to succeed.

> [!WARNING]
> Critical content demanding immediate user attention due to potential risks.

What would you like to be added:

https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax

Why is this needed:

Admonition is a custom standard for contented, this is a well establish alternative.

github-actions[bot] commented 1 year ago

@fuxingloh: Thanks for opening an issue, it is currently awaiting triage.

The triage/accepted label can be added by foundation members by writing /triage accepted in a comment.

Details I am a bot created to help the [levaintech](https://github.com/levaintech) developers manage community feedback and contributions. You can check out my [manifest file](https://github.com/levaintech/contented/blob/main/.github/governance.yml) to understand my behavior and what I can do. If you want to use this for your project, you can check out the [BirthdayResearch/oss-governance-bot](https://github.com/BirthdayResearch/oss-governance-bot) repository.
github-actions[bot] commented 1 year ago

@fuxingloh: There are no 'area' labels on this issue. Adding an appropriate label will greatly expedite the process for us. You can add as many area as you see fit. If you are unsure what to do you can ignore this!

You can add area labels by leaving a /area comment.

Details I am a bot created to help the [levaintech](https://github.com/levaintech) developers manage community feedback and contributions. You can check out my [manifest file](https://github.com/levaintech/contented/blob/main/.github/governance.yml) to understand my behavior and what I can do. If you want to use this for your project, you can check out the [BirthdayResearch/oss-governance-bot](https://github.com/BirthdayResearch/oss-governance-bot) repository.