Miscellaneous template instructions #1
Description
Pasting instructions / comments here from email thread, so they're easier to find, use and discuss (if needed).
Initial info (but trimmed) from @jbosch-noaa
I have copied over the IOOS Jekyll theme to base our webpage off of. Here is a link to the instructions page that Alex Birger put together to guide us. I haven't added any markdown files or anything else yet.
If you want to know what the theme looks like, check out the IOOS documentation page on GitHub. Actually the instructions page above is in the same theme.
Comments from @mwengren, mainly about tags
Things like the HTML title are created from a combination of settings in _config.yml.
The tags functionality I don't think we've really explored. Alex may know more about that than I do at this point. It would be nice to have a tag capability working though.
If you want to explore making it work, we accept pull requests back to the main theme repo: https://github.com/ioos/documentation-theme-jekyll (this is what is linked to in the submodule reference in your repo: https://github.com/ioos/BioData-Training-Workshop/tree/gh-pages).
Comments from @abirger about tags and text search functionality
Indeed, we have not worked on the tags; however, it is pretty easy to make them work – the tags that you want to be shown on the pages must first be allowed in the _data/tags.yml file. So, unless we come up with an all-inclusive IOOS-wide list of tags, it gets site-specific and should be managed accordingly.
One more thing worth mentioning: the text search on site (‘search’ box in the topnav bar) relies on the search.json file that is being populated from all documents on the site when builds the website (it is not the search.json file in the root directory of the gh-pages branch, it is the resulting search.json file that can be found in the _site directory when the site is building locally). If that file contains any invalid formatting, the search will not work; so, it would be a good idea to exclude all files that are not pertinent for search (put search:exclude in the file’s frontmatter), and validate the content of the _site/search.json file with some online JSON Validator (e.g. https://jsonlint.com/).