OxShef: Rmd Template Site

This is a template RMarkdown website for the OxShef project, please consider using this template if you are adding a new website to the project that will be written using RMarkdown files.

Current websites in OxShef that use this template include:

  • OxShef Charts: A guide to different visualisation options for visualising research data

There is a more thorough overview of the features of this website template (and how to use it) in the github readme.

Site Features

  • Bootstrap 4.0: Bootstrap is an awesome framework for building responsively designed websites, i.e. content that reflows as the size of the browser window changes, beautifully supporting a wide range of mobile devices. The main utility of Bootstrap in this template is for laying out grids, an example of which you can see above.

  • includes/include_institutional-support.html: The purple alert at the top of this page contains links to institutional support for the service/tool described within the website itself, linking to idn_info.html and orda_info.html respectively. Note that this is optionall included in the YAML header as follows:

output:
  html_document:
    toc_float: false
    includes:
      before_body: [includes/include_header.html, includes/include_institutional-support.html]

Bootstrap grid example

Note that HTML to can be included verbatim within the .Rmd files that generate each webpage, however the markdown engine does interpret content within HTML tags. This allows Markdown like this **bold** to be used to embolden text.

To guaranantee that HTML is rendered without any attempted magic you can make use of these special comments around the html:

<–html_preserve–>

<–/html_preserve–>

This section of the site should appear either directly to the right or underneath the information about html_preserve tags, as it is in another column of the bootstrap grid. The barchart below is generated using the highcharter library:

OxShef