prettier-plugin-embed icon indicating copy to clipboard operation
prettier-plugin-embed copied to clipboard

[docs] It's not clear what languages or identifiers are supported on first look on README

Open JounQin opened this issue 2 years ago • 4 comments

It seems we have to expand a details section to check what languages are supported and we have to jump into the source codes to see what related identifiers are supported.

JounQin avatar Dec 25 '23 01:12 JounQin

👍 Yes but currently I'm afraid I don't have the sufficient energy to maintain a well organized document. And many of the default identifiers or APIs may still be prone to change. I'll have to manually keep them updated if they are hardcoded in the docs. If you have better suggestions I'm all ears ❤️.

And the main question that somewhat concerns me is that it seems there aren't many users are currently benefit from this package. I may get more motivated if I can gather more feedbacks from the real world users, and the Prettier team, if this plugin helps.

Sec-ant avatar Dec 25 '23 07:12 Sec-ant

You can add a section with comments like <!-- languages and identifiers start --> + <!-- languages and identifiers end -->, and then use ts to generate that section automatically every time before releasing.

I can raise a PR for it.

JounQin avatar Dec 25 '23 07:12 JounQin

And the main question that somewhat concerns me is that it seems there aren't many users are currently benefit from this package. I may get more motivated if I can gather more feedbacks from the real world users, and the Prettier team, if this plugin helps.

I was seeking if markdown is supported by this plugin, but I can't find out easily.

And I believe this plugin should be a standard and change to be an official prettier plugin.

cc @fisker and @sosukesuzuki

JounQin avatar Dec 25 '23 07:12 JounQin

I can raise a PR for it.

You're more than welcome ❤️

And I believe this plugin should be a standard and change to be an official prettier plugin. cc @fisker and @sosukesuzuki

Thanks a lot for your voice~

Sec-ant avatar Dec 25 '23 07:12 Sec-ant