Skip to content

Use GitHub-flavored alert syntax for better docs rendering across GitHub and VitePress #187

@0xdevalias

Description

@0xdevalias

In skimming through the docs in the guide:

I noticed that they seem to be using VitePress specific custom containers for info/tip/warning/etc blocks:

That render fine on the website:

But aren't rendered properly when viewing that documentation on GitHub; eg.

It seems VitePress also supports GitHub flavoured alerts, that will render the same way, but will also work correctly when viewed on GitHub:

Fixing this up would improve the readability of this documentation when accessed directly from GitHub.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions