Allow custom shortcut icon to be specified

[jsit]

[valeriangalliat]

This will be a feature of sassdoc-theme-light, not directly of SassDoc.

I propose to add a shortcutIcon key in the view.json. It will target a file to use as shortcut icon. The path is relative to the view.json file.

The theme will copy the specified file into assets/img and use it as shortcut icon in the HTML layout.

Everything's okay?

[KittyGiraudel]

@SassDoc/owners Thoughts?

[FWeinb]

We should make it possible to specify a URL too.

[valeriangalliat]

👍

If it begins with *//, assume an URL, otherwise a path. Right?

[FWeinb]

A file path can also begin with *// like file:/// to have a absolute path.

[valeriangalliat]

In a browser maybe, but with commandline tools beginning a path with / is an absolute path, and file:/// is usually not supported.

So /path/to/favicon.ico is absolute, path/to/favicon.ico is relative, anything://path/to/favicon.ico will be passed as a raw URL, and //path/to/favicon.ico too.

[FWeinb]

👍 you are right

[valeriangalliat]

I'll add this in sassdoc-filter after reflection, so it can be reused. Or a Themeleon module since it needs to copy a file. I'm not sure...

[valeriangalliat]

Okay, I had to update:

• sassdoc-theme-light
• sassdoc-theme-default
• sassdoc-filter
• sassdoc
• themeleon

Everything's working for me on develop after a npm update.

[jsit]

If I specify a local path rather than an http url, the shortcut icon seems to default to assets/img/favicon.ico

[valeriangalliat]

The icon you specify is copied in assets/img/favicon.ico (so it's available wherever you publish the rendered documentation), but it should be the exact icon you specified in the configuration.