Skip to content
Website skeleton for your unconference
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
code
content
dat
docs
figs
static
themes/hugo-ropensci-theme
.gitignore
.nojekyll
LICENSE
Makefile
README.md
config.toml
index.Rmd

README.md

unconf-website

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 unconf-website repository.

Creating a Repository

  1. 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.

  2. Go to GitHub's importer.

  3. Paste the url of this repo as the old repository to clone: https://github.com/unconf-toolbox/unconf-website.

  4. Select the owner for your new repository. (This will probably be your Github organization, such as "chirunconf".)

  5. 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 chirunconf.github.io.

  6. Make sure the repository is public.

  7. 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

  1. 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 https://github.com/chirunconf/chirunconf.github.io.

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.]

  1. Edit all the places it says FIXME in config.toml. Also, make sure to change baseurl to 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 docs folder, which Github pages will automatically build into a website when you push your changes.

  2. Add your logo and additional images (cover photo, venue photo, participant photos) in the static/img folder.

  3. To include or exclude sections of the website, change the enable = true parameter to enable = false.

  4. (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).

  5. (Optional, to clean up your repository) Delete the figs folder, which is just for the README on the website template.

  6. (Optional, to clean up your repository) Rewrite this README to be something more descriptive of your unconf.

Credits

You can’t perform that action at this time.