forked from pages-themes/cayman
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
58 additions
and
64 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,96 +1,90 @@ | ||
| # `jekyll-theme-cayman` | ||
| # The Cayman theme | ||
|
|
||
| Cayman is a clean, responsive theme for [GitHub Pages](https://pages.github.com). | ||
| [](https://travis-ci.org/pages-themes/jekyll-theme-cayman) [](https://badge.fury.io/rb/jekyll-theme-cayman) | ||
|
|
||
| You can preview the theme at http://jasonlong.github.io/cayman-theme or with real content at http://jasonlong.github.io/geo_pattern. | ||
| *Cayman is a Jekyll theme for GitHub Pages. You can [preview the theme to see what it looks like](http://pages-themes.github.io/cayman), or even [use it today](#usage).* | ||
|
|
||
|  | ||
| ## Usage | ||
|
|
||
| ### Usage | ||
| To use the Cayman theme: | ||
|
|
||
| This theme was ported from the GitHub Automatic Page Generator to a Jekyll theme gem. To use it on a Pages site, add `theme: jekyll-theme-cayman` to your `_config.yml`. | ||
| 1. Add the following to your site's `_config.yml`: | ||
|
|
||
| Markdown files should be prefixed with the following frontmatter. | ||
| ```yml | ||
| theme: jekyll-theme-cayman | ||
| ``` | ||
| ```md | ||
| --- | ||
| layout: default | ||
| --- | ||
| 2. Optionally, if you'd like to preview your site on your computer, add the following to your site's `Gemfile`: | ||
|
|
||
| ``` | ||
| ```ruby | ||
| gem "github-pages", group: :jekyll_plugins | ||
| ``` | ||
|
|
||
| ### Customizations | ||
|
|
||
| ```yaml | ||
| theme: jekyll-theme-cayman | ||
|
|
||
| title: Custom title | ||
| description: Custom description. | ||
| show_downloads: true | ||
| google_analytics: | ||
| ``` | ||
| ## Customizing | ||
|
|
||
| - Set a custom `title` or `description`. | ||
| - Set `show_downloads` to `true` to show the download buttons in the header. | ||
| - Set `google_analytics` to your tracking ID to enable pageview tracking. | ||
| ### Configuration variables | ||
|
|
||
| #### CSS | ||
| Cayman will respect the following variables, if set in your site's `_config.yml`: | ||
|
|
||
| For CSS customization, create your own `/assets/css/styles.scss` in your project to replace the one from this theme. For convenience, the variables from `_sass/variables.scss` can simply be uncommented and their values modified. | ||
| ```yml | ||
| title: [The title of your site] | ||
| description: [A short description of your site's purpose] | ||
| ``` | ||
|
|
||
| A couple of nice sources for gradient colors are http://uigradients.com and http://jxnblk.com/shade/. | ||
| Additionally, you may choose to set the following optional variables: | ||
|
|
||
| ```scss | ||
| --- | ||
| --- | ||
| ```yml | ||
| show_downloads: ["true" or "false" to indicate whether to provide a download URL] | ||
| google_analytics: [Your Google Analytics tracking ID] | ||
| ``` | ||
|
|
||
| @import "normalize"; | ||
| @import "rouge-github"; | ||
| @import "variables"; | ||
| ### Stylesheet | ||
|
|
||
| // Breakpoints | ||
| // $large-breakpoint: 64em; | ||
| // $medium-breakpoint: 42em; | ||
| If you'd like to add your own custom styles: | ||
|
|
||
| // Headers | ||
| // $header-heading-color: #fff; | ||
| $header-bg-color: #8E0E00; | ||
| $header-bg-color-secondary: #1F1C18; | ||
| 1. Create a file called `/assets/css/style.css` in your site | ||
| 2. Add the following content to the top of the file, exactly as shown: | ||
| ```scss | ||
| --- | ||
| --- | ||
| // Text | ||
| // $section-headings-color: #159957; | ||
| // $body-text-color: #606c71; | ||
| // $body-link-color: #1e6bb8; | ||
| // $blockquote-text-color: #819198; | ||
| @import "{{ site.theme }}"; | ||
| ``` | ||
| 3. Add any custom CSS (or Sass, including imports) you'd like immediately after the `@import` line | ||
|
|
||
| // Code | ||
| // $code-bg-color: #f3f6fa; | ||
| // $code-text-color: #567482; | ||
| ### Layouts | ||
|
|
||
| // Borders | ||
| // $border-color: #dce6f0; | ||
| // $table-border-color: #e9ebec; | ||
| // $hr-border-color: #eff0f1; | ||
| If you'd like to change the theme's HTML layout: | ||
|
|
||
| @import 'cayman'; | ||
| ``` | ||
| 1. [Copy the original template](https://github.com/pages-themes/cayman/blob/master/_layouts/default.html) from the theme's repository<br />(*Pro-tip: click "raw" to make copying easier*) | ||
| 2. Create a file called `/_layouts/default.html` in your site | ||
| 3. Paste the default layout content copied in the first step | ||
| 4. Customize the layout as you'd like | ||
|
|
||
| #### Syntax Highlighting | ||
| ## Roadmap | ||
|
|
||
| [Rouge](http://rouge.jneen.net/) is the default highlighter in Jekyll 3. This theme includes the `github` stylesheet from Rouge. | ||
| See the [open issues](https://github.com/pagse-themes/cayman/issues) for a list of proposed features (and known issues). | ||
|
|
||
| To switch syntax highlighting colors to say `monokai`, install the `rouge` gem and run the following on the command line. | ||
| ## Project philosophy | ||
|
|
||
| ``` | ||
| mkdir _scss | ||
| rougify style monokai > _scss/rouge-monokai.scss | ||
| ``` | ||
| The Cayman theme is intended to make it quick and easy for GitHub Pages users to create their first (or 100th) website. The theme should meet the vast majority of users' needs out of the box, erring on the side of simplicity rather than flexibility, and provide users the opportunity to opt-in to additional complexity if they have specific needs or wish to further customize their experience (such as adding custom CSS or modifying the default layout). It should also look great, but that goes without saying. | ||
|
|
||
| ## Contributing | ||
|
|
||
| Interested in contributing to Cayman? We'd love your help. Cayman 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. | ||
|
|
||
| Then replace `rouge-github` with `rouge-monokai` in `/assets/css/styles.scss` | ||
| ### Previewing the theme locally | ||
|
|
||
| Other pygments highlighter themes should work as well. | ||
| If you'd like to preview the theme locally (for example, in the process of proposing a change): | ||
|
|
||
| 1. Clone down the theme's repository (`git clone https://github.com/pages-themes/cayman`) | ||
| 2. `cd` into the theme's directory | ||
| 3. Run `script/bootstrap` to install the necessary dependencies | ||
| 4. Run `bundle exec jekyll serve` to start the preview server | ||
| 5. Visit [`localhost:4000`](http://localhost:4000) in your browser to preview the theme | ||
|
|
||
| ### License | ||
| ### Running tests | ||
|
|
||
| This work is licensed under a [Creative Commons Attribution 4.0 International](http://creativecommons.org/licenses/by/4.0/) license. | ||
| The theme contains a minimal test suite, to ensure a site with the theme would build successfully. To run the tests, simply run `script/cibuild`. You'll need to run `script/bootstrap` one before the test script will work. |