search

singerdmx / flutter-quill

Rich text editor for Flutter
https://pub.dev/packages/flutter_quill
MIT License
2.6k stars 840 forks source link

Using GitHub alerts are not supported on pub.dev #2297

Closed EchoEllet closed 3 weeks ago

EchoEllet commented 1 month ago

See pub-dev #7278 or GitHub Discussion #16925 for the feature itself.

[!NOTE] GitHub alerts is a GitHub-specific feature and is not supported on pub.dev and we're publishing the package, writing docs, and releasing notes or changes using this feature which will be displayed incorrectly on pub.dev and make the content less readable.

We should either remove it and only use it in GitHub issues and discussions or GitHub releases (should not be used for pub.dev CHANGELOG).

A replacement for:

[!IMPORTANT] GitHub Alerts in an extension for Markdown and uses special syntax that's not commonly used in Markdown.

is:

IMPORTANT GitHub Alerts is an extension for Markdown and uses special syntax that's not commonly used in Markdown.

This is an example of text that use GitHub Alert in Markdown on pub.dev:

image

Same text in GitHub:

image

They have already added support for this feature in markdown 7.2.0.

This is currently a minor issue that require minimal changes to fix, though we should not use it anymore find another alternative/replacement, or simply avoid using it. While this feature is GitHub-specific, other platforms have already started to adopt it, GitBook and Kobweb Markdown Plugin already support this feature.

EchoEllet commented 3 weeks ago

It looks like pub.dev now supports GitHub alerts.