Skip to content

Commit 7633676

Browse files
committed
aa
1 parent 4a23fe4 commit 7633676

File tree

1 file changed

+109
-2
lines changed

1 file changed

+109
-2
lines changed

README.md

Lines changed: 109 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,109 @@
1-
# apmattil.github.io
2-
blog
1+
# The Time machine theme
2+
3+
[![Build Status](https://travis-ci.org/pages-themes/time-machine.svg?branch=master)](https://travis-ci.org/pages-themes/time-machine) [![Gem Version](https://badge.fury.io/rb/jekyll-theme-time-machine.svg)](https://badge.fury.io/rb/jekyll-theme-time-machine)
4+
5+
*Time machine is a Jekyll theme for GitHub Pages. You can [preview the theme to see what it looks like](http://pages-themes.github.io/time-machine), or even [use it today](#usage).*
6+
7+
![Thumbnail of Time machine](thumbnail.png)
8+
9+
## Usage
10+
11+
To use the Time machine theme:
12+
13+
1. Add the following to your site's `_config.yml`:
14+
15+
```yml
16+
theme: jekyll-theme-time-machine
17+
```
18+
19+
2. Optionally, if you'd like to preview your site on your computer, add the following to your site's `Gemfile`:
20+
21+
```ruby
22+
gem "github-pages", group: :jekyll_plugins
23+
```
24+
25+
## Customizing
26+
27+
### Configuration variables
28+
29+
Time machine will respect the following variables, if set in your site's `_config.yml`:
30+
31+
```yml
32+
title: [The title of your site]
33+
description: [A short description of your site's purpose]
34+
```
35+
36+
Additionally, you may choose to set the following optional variables:
37+
38+
```yml
39+
show_downloads: ["true" or "false" to indicate whether to provide a download URL]
40+
google_analytics: [Your Google Analytics tracking ID]
41+
```
42+
43+
### Stylesheet
44+
45+
If you'd like to add your own custom styles:
46+
47+
1. Create a file called `/assets/css/style.scss` in your site
48+
2. Add the following content to the top of the file, exactly as shown:
49+
```scss
50+
---
51+
---
52+
53+
@import "{{ site.theme }}";
54+
```
55+
3. Add any custom CSS (or Sass, including imports) you'd like immediately after the `@import` line
56+
57+
*Note: If you'd like to change the theme's Sass variables, you must set new values before the `@import` line in your stylesheet.*
58+
59+
### Layouts
60+
61+
If you'd like to change the theme's HTML layout:
62+
63+
1. [Copy the original template](https://github.com/pages-themes/time-machine/blob/master/_layouts/default.html) from the theme's repository<br />(*Pro-tip: click "raw" to make copying easier*)
64+
2. Create a file called `/_layouts/default.html` in your site
65+
3. Paste the default layout content copied in the first step
66+
4. Customize the layout as you'd like
67+
68+
### Overriding GitHub-generated URLs
69+
70+
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:
71+
72+
1. Look at [the template source](https://github.com/pages-themes/time-machine/blob/master/_layouts/default.html) to determine the name of the variable. It will be in the form of `{{ site.github.zip_url }}`.
73+
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:
74+
```yml
75+
github:
76+
zip_url: http://example.com/download.zip
77+
another_url: another value
78+
```
79+
3. When your site is built, Jekyll will use the URL you specified, rather than the default one provided by GitHub.
80+
81+
*Note: You must remove the `site.` prefix, and each variable name (after the `github.`) should be indent with two space below `github:`.*
82+
83+
For more information, see [the Jekyll variables documentation](https://jekyllrb.com/docs/variables/).
84+
85+
## Roadmap
86+
87+
See the [open issues](https://github.com/pages-themes/time-machine/issues) for a list of proposed features (and known issues).
88+
89+
## Project philosophy
90+
91+
The Time machine 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.
92+
93+
## Contributing
94+
95+
Interested in contributing to Time machine? We'd love your help. Time machine 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.
96+
97+
### Previewing the theme locally
98+
99+
If you'd like to preview the theme locally (for example, in the process of proposing a change):
100+
101+
1. Clone down the theme's repository (`git clone https://github.com/pages-themes/time-machine`)
102+
2. `cd` into the theme's directory
103+
3. Run `script/bootstrap` to install the necessary dependencies
104+
4. Run `bundle exec jekyll serve` to start the preview server
105+
5. Visit [`localhost:4000`](http://localhost:4000) in your browser to preview the theme
106+
107+
### Running tests
108+
109+
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.

0 commit comments

Comments
 (0)