marked-alert

A marked extension to support GFM alerts.

- Install
- Usage
- Options
- Default Alert Variants
- Related
- Contributing
- License

Install

You can install marked-alert using npm or yarn:

``bash
npm i marked-alert


or

Say we have the following file example.md:

`md


Example

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

> [!TIP]
> Optional information to help a user be more successful.

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

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

> [!CAUTION]
> Negative potential consequences of an action.
`

And our module example.js looks as follows:

`js
import { readFileSync } from 'node:fs'
import { Marked } from 'marked'
import markedAlert from 'marked-alert'

const html = new Marked()
.use(markedAlert())
.parse(readFileSync('example.md', 'utf8'))

console.log(html)
`

Now, running node example.js yields:

`html


Example

The markedAlert extension accepts the following configuration options:

- className: A string representing a custom CSS class for the alerts.
- variants: An array of alert variants, where each variant is configured with a type, icon, and title class name. This allows you to create different alert types.

$3

The extension includes default alert variants:

- [!NOTE]: Highlights information that users should take into account, even when skimming.
- [!TIP]: Optional information to help a user be more successful.
- [!IMPORTANT]: Crucial information necessary for users to succeed.
- [!WARNING]: Critical content demanding immediate user attention due to potential risks.
- [!CAUTION]: Negative potential consequences of an action.

Each variant has an associated icon and title class name.

You can customize the default alert variants and add your own. Here's an example:

`js
const options = {
variants: [
{
type: 'danger',
icon: '🚨',
title: 'Oh snap!', // optional
titleClassName: 'text-danger' // optional
}
]
}
`

Related

See extensions list.

Contributing

We 💛  issues.

When committing, please conform to the semantic-release commit standards. Please install commitizen and the adapter globally, if you have not already.

`bash
npm i -g commitizen cz-conventional-changelog
`

Now you can use git cz or just cz instead of git commit when committing. You can also use git-cz, which is an alias for cz.

`bash
git add . && git cz
``

License

!GitHub

A project by Stilearning © 2023-2024.