This repository provides a template for setting up your unconf website. You can find a demo of this site here.
Note: Don't fork this repository directly on GitHub. Instead, follow the instructions below to use Github's importer to copy this
unconf-website repository and customize it for your workshop. This will make it so that you don't have to worry about upstream changes to our
Creating a Repository
Log in to GitHub. (If you do not have an account, you can quickly create an organization account for free.) You must be logged in for the remaining steps to work.
Go to GitHub's importer.
Paste the url of this repo as the old repository to clone: https://github.com/unconf-toolbox/unconf-website.
Select the owner for your new repository. (This will probably be your Github organization, such as "chirunconf".)
Choose a name for your workshop website repository. If you are using a Github organization, this name should have the form ".github.io", such as
Make sure the repository is public.
You should now have something that looks like this:
Click "Begin Import". When the process is done, you will receive a message like "Importing complete! Your new repository chirunconf/chirunconf.github.io is ready." and you can go to the new repository by clicking on the name.
Customizing Your Website
- Go into your newly-created repository,
which will be at
https://github.com/your_organization/your-organization.github.io. For example, if your organization name is
chirunconf, the repository's URL will be
You can now either clone this repository and work on this locally, or edit
config.toml in the Github browser. [NOTE: site does not currently build automatically without being re-served locally, so ignore the second part of this sentence for the time being.]
Edit all the places it says FIXME in
config.toml. Also, make sure to change
baseurlto your own website address, such as "https://chirunconf.github.io/", otherwise none of the site formatting or images will show up (because the relative file paths will be wrong). If you've cloned this template locally, you can check your edits by running
blogdown::serve_site()after making changes. The site will be published to the
docsfolder, which Github pages will automatically build into a website when you push your changes.
Add your logo and additional images (cover photo, venue photo, participant photos) in the
To include or exclude sections of the website, change the
enable = trueparameter to
enable = false.
(Optional, to make your life easier) Add the published website URL to the URL section in the Github repo (at the top of the page).
(Optional, to clean up your repository) Delete the
figsfolder, which is just for the README on the website template.
(Optional, to clean up your repository) Rewrite this README to be something more descriptive of your unconf.
- The unconf template is forked from @njtierney's ozunconf 2018 website repository, which is based off of the Hugo @ropensci website theme. Thanks to both for their beautiful open source websites!
- This README is inspired by the Software Carpentry workshop website template.
- This template was created at the Chicago R Unconference by Sam Tyner and Angela Li