Skip to content

Meng-Heng/WebsiteAlerts

Repository files navigation

Introduction

This is the GFM Alerts extension for your website; a Parsedown extension; which recognizes the Alert syntax that we see on GitHub Markdown files and converts them rightfully so, along with the stylings. Read five fun facts about dolphins while you check out the different types of Alert.

Note

There are 36 species of marine dolphins - living in nearly all aquatic environments, including oceans, coastal, estuarine and freshwater - and in temperatures ranging from less than 0°C to more than 30°C.

Important

Bottlenose dolphins are one of the few species, along with apes and humans, that have the ability to recognise themselves in a mirror.

Tip

How do you eat a fish? They swallow a fish head first so the fish's spines don't catch in their throat.

Caution

Noise pollution from naval activity, the oil and gas industry, seismic surveys and underwater construction can stress and injure cetaceans.

Warning

Bottlenose dolphins are often killed accidentally in gillnets, driftnets, purse seines, trawls, long-lines and on hook-and-line gear used in fisheries.

NOTE: If you are not accessing this information through GitHub, then the examples above won't render. Check Result.

Feature

If you are looking to integrate GitHub Flavored Markdown Alert to your website and nothing more, let us get help you get started.

Getting started

Updates are coming!

How to use

  1. Start with > [!

  2. Choose the different type of Alerts.

  3. Close with ] .

  4. Start typing your context.

  5. Example

> [!NOTE] Fun fact about the dolphin is...
  1. If you have more than one type of the Alerts then
> [!NOTE] Fun fact about the dolphin is...

<!-- Include a comment here -->
> [!IMPORTANT] This is important
  1. That's it! Enjoy colorizing your information.

Result

  • Light mode Alerts in Light mode

To be implemented

  1. Dark mode & Light mode v2.0

Bugs and feature requests

Have a bug or a feature request? If there isn't one created already, please open a new issue.

Copyright and license

Copyright © 2024 the WebsiteAlerts Author. Code released under the MIT License.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published