Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improved favicon support #38

Closed
TysonMN opened this issue Jun 24, 2020 · 3 comments
Closed

Improved favicon support #38

TysonMN opened this issue Jun 24, 2020 · 3 comments

Comments

@TysonMN
Copy link
Contributor

TysonMN commented Jun 24, 2020

If the user provides a path to a favicon in the config...

page: {
favicon: '/favicon.ico',
},

...then CODEDOC adds the following link element...

{options.favicon ? <link rel="shortcut icon" href={options.favicon}/> : ''}

...to the head element.

A web programmer friend of mine recommended RealFaviconGenerator. Maybe there are a hundred sites like this; I am still new to this.

For what it's worth though, RealFaviconGenerator thinks there are many opportunities for codedoc.cc to improve its use of favicons. Here is the report.

Given a master image (with size 260x260 or more), these instructions show how to use the npm package cli-real-favicon to generate all the various image files and then modify any HTML to correctly reference those images.

Is there any desire for CODEDOC to take this on as a dependency to step up its favicon game?

Or would it be more appropriate to make a plugin for CODEDOC that utilizes ReadFaviconGenerator?

@loreanvictor
Copy link
Contributor

There is one particular error in the report pertaining to icon of pinned tabs on Safari. Safari however seems to have no problem with pinning codedoc.cc.

Besides that, the rest of the issues are about the resolution of the icon when you add it to your home screen. Since this is not the typical usage for websites generated by CODEDOC, I would say it falls out of core functionality and would be better suited for a plugin.

@TysonMN
Copy link
Contributor Author

TysonMN commented Jun 25, 2020

Oh, RealFaviconGenerator doesn't seem like such a good choice to me anymore. Its GitHub repo only has two commits from seven years ago.

@TysonMN
Copy link
Contributor Author

TysonMN commented Jun 25, 2020

Humm...that was only one of the repos in that GitHub organization. Other repos were updated more recently.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants