diff --git a/README.md b/README.md index 801d7a9..424e109 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ *Hacker is a Jekyll theme for GitHub Pages. You can [preview the theme to see what it looks like](http://pages-themes.github.io/hacker), or even [use it today](#usage).* -![Thumbnail of hacker](thumbnail.png) +![Thumbnail of Hacker](thumbnail.png) ## Usage @@ -22,8 +22,6 @@ To use the Hacker theme: gem "github-pages", group: :jekyll_plugins ``` - - ## Customizing ### Configuration variables @@ -56,6 +54,8 @@ If you'd like to add your own custom styles: ``` 3. Add any custom CSS (or Sass, including imports) you'd like immediately after the `@import` line +*Note: If you'd like to change the theme's Sass variables, you must set new values before the `@import` line in your stylesheet.* + ### Layouts If you'd like to change the theme's HTML layout: @@ -65,6 +65,23 @@ If you'd like to change the theme's HTML layout: 3. Paste the default layout content copied in the first step 4. Customize the layout as you'd like +### Overriding GitHub-generated URLs + +Templates often rely on URLs supplied by GitHub such as links to your repository or links to download your project. If you'd like to override one or more default URLs: + +1. Look at [the template source](https://github.com/pages-themes/hacker/blob/master/_layouts/default.html) to determine the name of the variable. It will be in the form of `{{ site.github.zip_url }}`. +2. Specify the URL that you'd like the template to use in your site's `_config.yml`. For example, if the variable was `site.github.url`, you'd add the following: + ```yml + github: + zip_url: http://example.com/download.zip + another_url: another value + ``` +3. When your site is built, Jekyll will use the URL you specified, rather than the default one provided by GitHub. + +*Note: You must remove the `site.` prefix, and each variable name (after the `github.`) should be indent with two space below `github:`.* + +For more information, see [the Jekyll variables documentation](https://jekyllrb.com/docs/variables/). + ## Roadmap See the [open issues](https://github.com/pages-themes/hacker/issues) for a list of proposed features (and known issues). @@ -75,7 +92,7 @@ The Hacker theme is intended to make it quick and easy for GitHub Pages users to ## Contributing -Interested in contributing to Hacker? We'd love your help. Hacker is an open source project, built one contribution at a time by users like you. See [the CONTRIBUTING file](CONTRIBUTING.md) for instructions on how to contribute. +Interested in contributing to Hacker? We'd love your help. Hacker is an open source project, built one contribution at a time by users like you. See [the CONTRIBUTING file](docs/CONTRIBUTING.md) for instructions on how to contribute. ### Previewing the theme locally