Skip to content

GitBook-specific syntax in README doesn’t render correctly on GitHub #152

@ahmedelsayad11

Description

@ahmedelsayad11

Documentation issue

Hi 👋,

I noticed that the README.md contains GitBook-specific syntax blocks such as

Image

{% hint style="info" %} ... {% endhint %}
{% hint style="warning" %} ... {% endhint %}
{% embed url="..." %}

Motivation

These render fine in GitBook but appear as raw text on GitHub, which may confuse readers who view the project directly here.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions