use nmfs-fish-tools pkgdown template

[kellijohnson-NOAA]

Thanks to @eeholmes and @ChristineStawitz-NOAA for the NMFS pkgdown template. I would like to use this for ss3sim documentation. Just trying to figure out what files I need to add because it is not a new repository, which is not really that clear from the Instructions. It appears that I need to do the following:

• place a logo image in .\man\figures\
• update the favicon using pkgdown::build_favicon()
• add the extra.css file to the pkgdown folder
• build the website, which is stored in docs using pkgdown::build_site()
• Change to using README.Rmd and add GitHub action to build README.md upon committing to main

[ChristineStawitz-NOAA]

Bai Li wrote this guide for existing tools: https://noaa-fisheries-integrated-toolbox.github.io/resources/workshops/NOAA-pkgdown/

Let me know if that helps!

[ChristineStawitz-NOAA]

more details: the main work here is setting it up to use pkgdown - once you do that, using the NOAA template should just be as simple as adding the single line of code to extra.css and you can link to the Github-published NOAA logo (link in the blog post above) instead of putting the image file in your repo. The biggest headache of using pkgdown for me was helping it find all the right folders for the images, so it's easier to link to the web logo IMO.

[kellijohnson-NOAA]

This is great @ChristineStawitz-NOAA, thank you so much. I think that providing this information in the repository with the template would be helpful. I can file an issue at nmfs pkgdownTemplate if you want me to?

[ChristineStawitz-NOAA]

I put it in the README..let me know if it's easy to find!

[eeholmes]

I think Kelli is referring to the package logo not the NOAA logo. I thought I set up the template so that you can just clone the pkgdownTemplate repo. The extra.css file is there already and all the image links to NOAA logos are set up.

You just swap out the package logo file for yours and update any links.

Eli

[kellijohnson-NOAA]

Thanks @ChristineStawitz-NOAA Bai's instructions are much easier to find now. @eeholmes the template is really only helpful for people without an existing repository, which I think will often not be the case. It would be good to add some helper functions to the template package that allow users to retrofit existing repositories with the template.