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

URL for favicon #10

Closed MrRefactoring closed 2 years ago

MrRefactoring commented 2 years ago

Hi @Drarig29! Thanks for your plugin.

I considered adding a favicon to my docs via URL to host where SVG placed.

What do you think about this functionality?

Drarig29 commented 2 years ago

It's almost already possible. I think we just need not to try to copy the file and simply give a URL instead of a filename.

But one could also download the favicon and specify the filename...

Do you want to make a PR?

MrRefactoring commented 2 years ago

I think I can do it

MrRefactoring commented 2 years ago

Could you help me with the minimal supported NodeJS version in this lib?

Edited: I want to use the WHATWG URL module. It's was added in NodeJS v10

Drarig29 commented 2 years ago

Oh! I think I put NodeJS 15 in the dev dependencies but it's not a minimal version... you can use the plugin with lower versions of Node I think.

Drarig29 commented 2 years ago

Edited: I want to use the WHATWG URL module. It's was added in NodeJS v10

I would rather not add a dependency to the plugin... Why do you think it's needed? Can't you use a native Node.js way to determine if the path is a URL?

Maybe even a startsWith() or a /^https?/ regex?

MrRefactoring commented 2 years ago

Yeah, I think about regex too.

Edited: WHATWG URL is not a new dependency. Its native NodeJS and JS functional

Drarig29 commented 2 years ago

Oh okay, so don't hesitate to use it if it's not too overkill.

MrRefactoring commented 2 years ago

Oh, I forgot to change the favicon description in README. Can you do it?

Drarig29 commented 2 years ago

Yes go for it ^^

I shouldn't have rebased your PR, now your PR shows as closed instead of merged...

MrRefactoring commented 2 years ago

It's not a problem)