fsprojects / FSharp.Formatting

F# tools for generating documentation (Markdown processor and F# code formatter)
https://fsprojects.github.io/FSharp.Formatting/
Other
462 stars 155 forks source link

Favicon not showing for API docs #773

Closed brianrourkeboll closed 1 year ago

brianrourkeboll commented 1 year ago

Should this

https://github.com/fsprojects/FSharp.Formatting/blob/d0ac84e3a39221cc536d34a57e3f0f9dfec0f2df/docs/_template.html#L16

instead be something like

- <link rel="shortcut icon" type="image/x-icon" href="img/favicon.ico"> 
+ <link rel="shortcut icon" type="image/x-icon" href="{{root}}img/favicon.ico"> 

?

Right now, the favicon shows for top-level files, but not for generated API docs under /reference. You can currently see this for the docs for this repo itself:

Compare https://fsprojects.github.io/FSharp.Formatting/ with favicon

image

But https://fsprojects.github.io/FSharp.Formatting/reference/index.html without

image

When I make the change suggested above (prepending {{root}} to img/favicon.ico{{root}}img/favicon.ico) to the template in one of my own projects, the favicon now works correctly for both top-level files and API docs.

dsyme commented 1 year ago

@brianrourkeboll Yes that looks right - can you submit a PR please to fix this? Thanks

brianrourkeboll commented 1 year ago

@dsyme #775.