hosseinmd / prettier-plugin-jsdoc

A Prettier plugin to format JSDoc comments.
MIT License
232 stars 28 forks source link

Bold text that uses stars gets converted to a dot point #91

Closed Dan503 closed 3 years ago

Dan503 commented 3 years ago

If I have the following comment:

    /**
     * Some comment text.
     *
     * **Warning:** I am a warning.
     */

It should get rendered like this

Some comment text.

Warning: I am a warning.

However prettier converts it to this:

    /**
     * Some comment text.
     *
     * - *Warning:** I am a warning.
     */

Which gets rendered as

Some comment text.

  • *Warning:\ I am a warning.
Dan503 commented 3 years ago

So far I've been working around this issue by formatting it like this:

    /**
     * Some comment text.
     *
     * __Warning:__ I am a warning.
     */

It works but I would proffer if I could use stars for bold text rather than underscores.

hosseinmd commented 3 years ago

Published in v0.3.12