Website contributions

Simeon
blogdown, hugo, netlify, Rstudio

This website is made with github, the blogdown R package, and the Academic theme for Hugo.

There are many ways to edit this website. I consider the R Studio way the easiest. So, if you want to edit your research challange or contribute to the website, the information below will (hopefully) help you getting up and running with R blogdown and our Autumn School 2020 website.

1 Read up on blogdown

Before you start, you may want to have some background information:

2 Setup

You need to have R and RStudio installed (make sure to have a recent version > 3.4).

3 In R Studio

  • Go to File -> New Project
  • Select, Version Control -> Git
  • Copy paste https://github.com/slisovski/GeoX_autumnSchool2020 into the Repository URL box, change the directory if nessesary and press Create Project.

R studio will pull the entire website directory into the specified path.

The important folder within the directory is the content folder:

...
├── content
│   ├── home
│   ├── info
│   ├── mentor
│   ├── program
│   ├── project
│   └── projects
...
  • content: contains .md or .Rmd files used to render the page
    • home: all sites displayed on the first page
    • info: this site
    • mentor: the become a mentor site
    • program: the program site
    • project: the project folders
    • projects: widget for project site

3.1 Change your project site

You can now start and open e.g. your research project site, make changes etc. Once you are finished, you can comit your changes via the Git window in R Studio. Here, you will see, all files that you changed. Select the one you want to push to the respository and to the website, provide some information on your changes and press commit. The final step is to Push your commits.

To avoid conflicts between pushes from several people working on the very same document. You can create a New Branch in the git window. Give it a sensible name (e.g. your username) and commit as well as push all changes into this branch. I will keep track of these changes and merge them into the masater branch.

If you have any questions, feel free to ask!

4 Caveats, disclaimers, etc.

Even with all the resources listed above, getting up and running takes a few tries. Here are some additional places to get started:

On a mac you may also need Xcode and Homebrew installed- you will probably need these to download Hugo. If you don’t have either but are on a mac, this link may help:

blogdown