This is a simple example of setting up an electronic lab notebook using blogdown and the static site generator hugo.
The theme used it this example is a slightly modified version of temple, which is a minimal, distraction free theme suitable for electronic notebooking (in my opinion). If interested, you can find a large list of hugo themes here: https://themes.gohugo.io/
The overall setup here involves each notebook entry (post) to be assigned at least one category, i.e. Experiment, Reading, Writing. All entries will then be grouped under these headings at the top of the page. The 'home' page of the notebook contains all recent entries, with the most recent date first. Entries can also be tagged (i.e. R, regression, analysis, literature, ...) which allows further refinement in terms of grouping posts and searching for specfic topics.
The following should get you set up with a working version of the example notebook. For an excellent and detailed guide from start to finish please see https://alison.rbind.io/post/up-and-running-with-blogdown/
- fork this repository to your own GitHub account
- clone/download the forked repository so you have a local folder
- open the RStudio project (in RStudio)
- ensure you have
blogdown
andhugo
installed ( guide: https://bookdown.org/yihui/blogdown/installation.html )
- ensure you have
- create new posts/entries and customise the site to your taste
- push changes and new content back to your forked version on GitHub
- set up either a Netlify or GitHub pages method to serve your site:
- a nice guide to Netlify: https://alison.rbind.io/post/up-and-running-with-blogdown/#deploy-in-netlify
- enjoy your shiny new notebook!
- add a basic setup guide
- integrate static site with Netlify for auto-updating upon git push
- add some more advanced content (i.e. htmlwidgets, shiny, etc.)
- add an interactive timeline
- add an example of a data table
- customise the temple theme to accept user-defined code highlighting css