SOPs
New tutorials should go in a new directory in content/tutorials. Use plain markdown files (.md) as much a possible. Use Rmarkdown files (.Rmd) when calculations in R are required. For more information about creating a new tutorial, check the create tutorial page.
The technology used to create the website is Hugo, a static website generator. Hugo will process all the markdown files - ignoring Rmd, which is why these need to be knit beforehand - and create the necessary files (html, css, js) for the website. These are served from the gh-pages branch.
Travis will automatically run the steps above (install Hugo, download theme, run Hugo, deploy website) for every pull request or commit to the master branch. You will see in the pull request if the build was successful. If not, check the build logs to figure out what went wrong.
- Install hugo
- Clone the tutorials repository
- In the cloned tutorials directory, install the theme with
git clone https://github.com/MunifTanjim/minimo.git --branch v2.7.0 themes/minimo - Build and serve the site with
hugo server -D
For more information, see Hugo's getting started documentation.
The tutorials website makes use of the Hugo theme minimo. This theme is not included in the repository, but downloaded by Travis at build time. This avoids clutter and changes to the theme itself. To customize the theme:
- Browse the
layoutsdirectory in the minimo repository to see which template file you want to customize - Copy the template file to the same path in the
layoutsdirectory of this repository - Edit the file to the desired effect. E.g. this update to the original minimo file adds a "edit this page" link for every page.
- Hugo will now use your customized file instead of the default theme file.
For more information, see the Hugo theme customization documentation. To test theme customization, it is best to build the site on your local computer (see above).
Creative Commons Attribution for content / MIT License for source code.