ceevee 0.1.1 → 0.1.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (3) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +122 -8
  3. metadata +3 -3
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 8c6c79a7c89f77014cbcadecf0e4851e1af57cc94a337778e4c539e8404aa6f9
4
- data.tar.gz: 9892a71d28907bb6af53fd7c59797d48b9569e68c083d6877cdd60c1640c6b54
3
+ metadata.gz: a32c5ee42b174503b65cd927691ee32a1d98dcb11e369671c56d968b1c2d9cf2
4
+ data.tar.gz: 7dd1c41517c112d1f83100feb71b2c511c8c1ebcf699ac7890ccbb0c571a3685
5
5
  SHA512:
6
- metadata.gz: d6c02ce9706ff61409fdc167ff4187bd2cbcf606524e84898841696a3907fdff7c06234bdc87a0febb61f65abf165b35c5492e562090666d7f9a83d1f7b28084
7
- data.tar.gz: 4041795c1597c88c6083052b50ea2b40c706db761cbdbe2003a6bfda16efb0b99c9a262104d325f25fd116ad4d973482578790bdf36b3c25381c57571a85ff83
6
+ metadata.gz: 1fcb3de2cb0c7a4a4311b5eb284a00af948d827ac77a1b92ddb5195b97dd66fce5320b4a801c3f54a198c66db1ac9380fe03dc48872a32defcb688d74650ea1a
7
+ data.tar.gz: '08626ba881e4b1a558bf659be61a0b1ea805982e2325ab56ab48c0eaccd80ba57dc14de78164b46a6efdc87310ef1e1aa0e55726eaac76378eac83498701b3b4'
data/README.md CHANGED
@@ -1,11 +1,20 @@
1
1
 
2
2
  # ceevee
3
3
 
4
- Ceevee is a Jekyll theme for a personal website. It has a blog, a projects page and a timeline that can be used for a CV.
4
+ ceevee is a Jekyll theme for a personal website. It has a blog, a projects page and a timeline that can be used for a CV.
5
5
 
6
6
  ## Installation
7
7
 
8
- Add this line to your Jekyll site's `Gemfile`:
8
+ If you haven't already, set up a new Jekyll site:
9
+ ```
10
+ gem install bundler jekyll
11
+ jekyll new my-awesome-site
12
+ cd my-awesome-site
13
+ bundle exec jekyll serve
14
+ # => Now browse to http://localhost:4000 to see your site
15
+ ```
16
+
17
+ Add the following line to your Jekyll site's `Gemfile`:
9
18
 
10
19
  ```ruby
11
20
  gem "ceevee"
@@ -17,17 +26,122 @@ And add this line to your Jekyll site's `_config.yml`:
17
26
  theme: ceevee
18
27
  ```
19
28
 
20
- And then execute:
29
+ Then execute:
30
+ ```
31
+ $ bundle install
32
+ ```
21
33
 
22
- $ bundle
23
34
 
24
- Or install it yourself as:
35
+ ## Usage
25
36
 
26
- $ gem install ceevee
37
+ ### Configuration in `_config.yml`
27
38
 
28
- ## Usage
39
+ You can add the following properties in `_config.yml` to customize the sidebar and page header.
40
+
41
+ ```
42
+ # Author will be shown in sidebar.
43
+ author: "Your name"
44
+
45
+ # Author's title will be shown in sidebar below name.
46
+ author_title: "Your title"
47
+
48
+ # A path that points to the author's profile picture.
49
+ author_picture: /assets/profile-picture.jpg
50
+
51
+ # A list of pages that get linked from the header.
52
+ header_pages:
53
+ - index.md
54
+ - projects.md
55
+ - cv.html
56
+
57
+ # A list of sections that will be shown in sidebar.
58
+ sidebar_sections:
59
+ - title: "About"
60
+ text: "I am a photographer. I like to go out into nature."
61
+ - title: "Contact"
62
+ text: "Just write me an email."
63
+ ```
64
+
65
+ ### Layouts
66
+
67
+ #### home
68
+
69
+ The `home` layout shows a preview list of all posts that have their layout set to `post`.
70
+
71
+ #### portfolio
72
+
73
+ The `portfolio` layout shows a preview list of all posts that have their layout set to `project`.
74
+
75
+ #### timeline
76
+
77
+ When using the `timeline` layout, you have to fill in the content into the page it self. Example:
78
+
79
+ ```
80
+ ---
81
+ layout: timeline
82
+ title: CV
83
+ permalink: /cv/
84
+ ---
85
+
86
+ <h1>Experience</h1>
87
+
88
+ <div class="section">
89
+ <div class="bubble"></div>
90
+ <div class="date">04/2009 - 10/2015</div>
91
+ <h2>Senior Super Professional</h2>
92
+ <h3>Some Company Name | Berlin (DE)</h3>
93
+ <a class="link" target="_blank" href="http://www.example.com">http://www.example.com</a>
94
+
95
+ <ul class="description">
96
+ <li>Lorem ipsum dolor sit amet, consectetur adipiscing elit</li>
97
+ <li>Lorem ipsum dolor sit amet, consectetur adipiscing elit</li>
98
+ <li>Lorem ipsum dolor sit amet, consectetur adipiscing elit</li>
99
+ </ul>
100
+
101
+ <div class="tags">
102
+ <span>Tag 1</span>
103
+ <span>Tag 2</span>
104
+ <span>Tag 3</span>
105
+ </div>
106
+ </div>
107
+
108
+ <div class="section">
109
+ <div class="bubble"></div>
110
+ <div class="crossline"></div>
111
+ <div class="date">04/2009 - 10/2015</div>
112
+ <h2>Senior Super Professional</h2>
113
+ <h3>Some Company Name | Berlin (DE)</h3>
114
+ <a class="link" target="_blank" href="http://www.example.com">http://www.example.com</a>
115
+
116
+ <ul class="description">
117
+ <li>Lorem ipsum dolor sit amet, consectetur adipiscing elit</li>
118
+ <li>Lorem ipsum dolor sit amet, consectetur adipiscing elit</li>
119
+ <li>Lorem ipsum dolor sit amet, consectetur adipiscing elit</li>
120
+ </ul>
121
+
122
+ <div class="tags">
123
+ <span>Tag 1</span>
124
+ <span>Tag 2</span>
125
+ <span>Tag 3</span>
126
+ </div>
127
+ </div>
128
+ ```
129
+
130
+
131
+ ### Posts
132
+
133
+ Posts should have at least the following front matter:
134
+ ```
135
+ ---
136
+ layout: post
137
+ title: "Lorem ipsum"
138
+ tagline: "Lorem ipsum and a bit more"
139
+ image: "/assets/img1.jpg"
140
+ ---
141
+ ```
142
+
143
+ The value for `layout` can be `post`or `project`.
29
144
 
30
- TODO: Write usage instructions here. Describe your available layouts, includes, sass and/or assets.
31
145
 
32
146
  ## Contributing
33
147
 
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: ceevee
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.1
4
+ version: 0.1.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Mathias Schaeffner
@@ -16,14 +16,14 @@ dependencies:
16
16
  requirements:
17
17
  - - "~>"
18
18
  - !ruby/object:Gem::Version
19
- version: '3.8'
19
+ version: '3.7'
20
20
  type: :runtime
21
21
  prerelease: false
22
22
  version_requirements: !ruby/object:Gem::Requirement
23
23
  requirements:
24
24
  - - "~>"
25
25
  - !ruby/object:Gem::Version
26
- version: '3.8'
26
+ version: '3.7'
27
27
  - !ruby/object:Gem::Dependency
28
28
  name: jekyll-seo-tag
29
29
  requirement: !ruby/object:Gem::Requirement