|
1 | | -# The Cayman theme |
2 | | - |
3 | | -[](https://github.com/pages-themes/cayman/actions/workflows/ci.yaml) [](https://badge.fury.io/rb/jekyll-theme-cayman) |
4 | | - |
5 | | -*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).* |
6 | | - |
7 | | - |
8 | | - |
9 | | -## Usage |
10 | | - |
11 | | -To use the Cayman theme: |
12 | | - |
13 | | -1. Add the following to your site's `_config.yml`: |
14 | | - |
15 | | - ```yml |
16 | | - remote_theme: pages-themes/[email protected] |
17 | | - plugins: |
18 | | - - jekyll-remote-theme # add this line to the plugins list if you already have one |
19 | | - ``` |
20 | | -
|
21 | | -2. Optionally, if you'd like to preview your site on your computer, add the following to your site's `Gemfile`: |
22 | | - |
23 | | - ```ruby |
24 | | - gem "github-pages", group: :jekyll_plugins |
25 | | - ``` |
26 | | - |
27 | | -## Customizing |
28 | | - |
29 | | -### Configuration variables |
30 | | - |
31 | | -Cayman will respect the following variables, if set in your site's `_config.yml`: |
32 | | - |
33 | | -```yml |
34 | | -title: [The title of your site] |
35 | | -description: [A short description of your site's purpose] |
36 | | -``` |
37 | | - |
38 | | -Additionally, you may choose to set the following optional variables: |
39 | | - |
40 | | -```yml |
41 | | -show_downloads: ["true" or "false" (unquoted) to indicate whether to provide a download URL] |
42 | | -google_analytics: [Your Google Analytics tracking ID] |
43 | | -``` |
44 | | - |
45 | | -### Stylesheet |
46 | | - |
47 | | -If you'd like to add your own custom styles: |
48 | | - |
49 | | -1. Create a file called `/assets/css/style.scss` in your site |
50 | | -2. Add the following content to the top of the file, exactly as shown: |
51 | | - ```scss |
52 | | - --- |
53 | | - --- |
54 | | -
|
55 | | - @import "{{ site.theme }}"; |
56 | | - ``` |
57 | | -3. Add any custom CSS (or Sass, including imports) you'd like immediately after the `@import` line |
58 | | - |
59 | | -*Note: If you'd like to change the theme's Sass variables, you must set new values before the `@import` line in your stylesheet.* |
60 | | - |
61 | | -### Layouts |
62 | | - |
63 | | -If you'd like to change the theme's HTML layout: |
64 | | - |
65 | | -1. For some changes such as a custom `favicon`, you can add custom files in your local `_includes` folder. The files [provided with the theme](https://github.com/pages-themes/cayman/tree/master/_includes) provide a starting point and are included by the [original layout template](https://github.com/pages-themes/cayman/blob/master/_layouts/default.html). |
66 | | -2. For more extensive changes, [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*) |
67 | | -3. Create a file called `/_layouts/default.html` in your site |
68 | | -4. Paste the default layout content copied in the first step |
69 | | -5. Customize the layout as you'd like |
70 | | - |
71 | | -### Customizing Google Analytics code |
72 | | - |
73 | | -Google has released several iterations to their Google Analytics code over the years since this theme was first created. If you would like to take advantage of the latest code, paste it into `_includes/head-custom-google-analytics.html` in your Jekyll site. |
74 | | - |
75 | | -### Overriding GitHub-generated URLs |
76 | | - |
77 | | -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: |
78 | | - |
79 | | -1. Look at [the template source](https://github.com/pages-themes/cayman/blob/master/_layouts/default.html) to determine the name of the variable. It will be in the form of `{{ site.github.zip_url }}`. |
80 | | -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: |
81 | | - ```yml |
82 | | - github: |
83 | | - zip_url: http://example.com/download.zip |
84 | | - another_url: another value |
85 | | - ``` |
86 | | -3. When your site is built, Jekyll will use the URL you specified, rather than the default one provided by GitHub. |
87 | | - |
88 | | -*Note: You must remove the `site.` prefix, and each variable name (after the `github.`) should be indent with two space below `github:`.* |
89 | | - |
90 | | -For more information, see [the Jekyll variables documentation](https://jekyllrb.com/docs/variables/). |
91 | | - |
92 | | -## Roadmap |
93 | | - |
94 | | -See the [open issues](https://github.com/pages-themes/cayman/issues) for a list of proposed features (and known issues). |
95 | | - |
96 | | -## Project philosophy |
97 | | - |
98 | | -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. |
99 | | - |
100 | | -## Contributing |
101 | | - |
102 | | -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](docs/CONTRIBUTING.md) for instructions on how to contribute. |
103 | | - |
104 | | -### Previewing the theme locally |
105 | | - |
106 | | -If you'd like to preview the theme locally (for example, in the process of proposing a change): |
107 | | - |
108 | | -1. Clone down the theme's repository (`git clone https://github.com/pages-themes/cayman`) |
109 | | -2. `cd` into the theme's directory |
110 | | -3. Run `script/bootstrap` to install the necessary dependencies |
111 | | -4. Run `bundle exec jekyll serve` to start the preview server |
112 | | -5. Visit [`localhost:4000`](http://localhost:4000) in your browser to preview the theme |
113 | | - |
114 | | -### Running tests |
115 | | - |
116 | | -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` once before the test script will work. |
| 1 | +PremiLab-Math at Xi'an Jiaotong Liverpool University |
0 commit comments