---
url: /api/renderers/react-markdown/src/functions/parseAlertMarker.md
---
[pantoken-root](../../../../index.md) / [renderers/react-markdown/src](../index.md) / parseAlertMarker

# Function: parseAlertMarker()

> **parseAlertMarker**(`text`): { `marker`: [`AlertMarker`](../type-aliases/AlertMarker.md); `rest`: `string`; } | `undefined`

Beta

Detect a GitHub alert marker at the start of text; returns the marker and the remaining text.

## Parameters

### text

`string`

## Returns

{ `marker`: [`AlertMarker`](../type-aliases/AlertMarker.md); `rest`: `string`; } | `undefined`

## Example

```ts
import { parseAlertMarker } from "@pantoken/react-markdown";

parseAlertMarker("[!TIP] Helpful"); // { marker: "TIP", rest: "Helpful" }
parseAlertMarker("Plain text"); // undefined
```