Skip to content

feat: Add support for GitHub Alerts natively #831

@ryzrr

Description

@ryzrr

Problem
doc-kit currently does not support GitHub-style alert syntax (e.g. > [!NOTE], > [!WARNING]).
These are rendered as plain blockquotes since remark-gfm explicitly does not cover this syntax.

Proposal
Integrate a plugin like remark-alerts into the doc-kit pipeline to parse and render these blocks correctly.

Example
Input:

Note

This is a note.

Current output: plain blockquote
Expected output: styled alert div, matching GitHub's rendering

Open to discussion on which plugin is the best fit if there are alternatives.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions