search

Drarig29 / typedoc-plugin-extras

A plugin for TypeDoc which adds extras to the generated documentation
https://drarig29.github.io/typedoc-plugin-extras/
MIT License
13 stars 3 forks source link

Add option to specify a custom description #13

Closed pixeldesu closed 2 years ago

pixeldesu commented 2 years ago

Noticed this wasn't a feature yet, so I decided to quickly add this.

Adds the ability to specify a custom meta description using customDescription. And in order to prevent escaping of the attribute at the top (even though there isn't much of a malicious vector here), the custom description is also stripped of any " characters.

Drarig29 commented 2 years ago

Hi! Good idea! I'm not on my laptop currently, what's the default description by the way?

pixeldesu commented 2 years ago

what's the default description by the way?

The default description set by TypeDoc is Documentation for {name} (where {name} is either defined in the options or guessed) which can be unfitting in some cases.

Drarig29 commented 2 years ago

Okay! I'm tempted to merge right now, but I prefer to merge and publish it right away when I'm on my laptop 😉

pixeldesu commented 2 years ago

No rush! Take your time with testing/releasing!