Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mschaeffner/ceevee
A Jekyll theme for a personal website
https://github.com/mschaeffner/ceevee
blog ceevee jekyll jekyll-theme sass theme
Last synced: 3 months ago
JSON representation
A Jekyll theme for a personal website
- Host: GitHub
- URL: https://github.com/mschaeffner/ceevee
- Owner: mschaeffner
- License: mit
- Created: 2018-05-29T08:39:53.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-05-20T10:50:52.000Z (over 5 years ago)
- Last Synced: 2024-09-28T18:08:34.508Z (3 months ago)
- Topics: blog, ceevee, jekyll, jekyll-theme, sass, theme
- Language: CSS
- Homepage: https://mschaeffner.com
- Size: 9.41 MB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# ceevee
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. An example website that uses this Jekyll theme is https://mschaeffner.com
## Installation
If you haven't already, set up a new Jekyll site:
```
gem install bundler jekyll
jekyll new my-awesome-site
cd my-awesome-site
bundle exec jekyll serve
# => Now browse to http://localhost:4000 to see your site
```
Add the following line to your Jekyll site's `Gemfile`:
```ruby
gem "ceevee"
```
And add this line to your Jekyll site's `_config.yml`:
```yaml
theme: ceevee
```
If you want to publish you site to GitHub pages, then you also have to define the following properties:
```yaml
remote_theme: mschaeffner/ceevee
url: .github.io
baseurl: /
```
Then execute:
```
$ bundle install
```
## Usage
### Configuration in `_config.yml`
You can add the following properties in `_config.yml` to customize the sidebar and page header.
```
# Author will be shown in sidebar.
author: "Your name"
# Author's title will be shown in sidebar below name.
author_title: "Your title"
# A path that points to the author's profile picture.
author_picture: /assets/profile-picture.jpg
# A list of pages that get linked from the header.
header_pages:
- index.md
- projects.md
- cv.html
# A list of sections that will be shown in sidebar.
sidebar_sections:
- title: "About"
text: "I am a photographer. I like to go out into nature."
- title: "Contact"
text: "Just write me an email."
```
### Layouts
#### home
The `home` layout shows a preview list of all posts that have their layout set to `post`.
#### portfolio
The `portfolio` layout shows a preview list of all posts that have their layout set to `project`.
#### timeline
When using the `timeline` layout, you have to fill in the content into the page it self. Example:
```
---
layout: timeline
title: CV
permalink: /cv/
---
Experience
04/2009 - 10/2015
Senior Super Professional
Some Company Name | Berlin (DE)
http://www.example.com
- Lorem ipsum dolor sit amet, consectetur adipiscing elit
- Lorem ipsum dolor sit amet, consectetur adipiscing elit
- Lorem ipsum dolor sit amet, consectetur adipiscing elit
04/2009 - 10/2015
Senior Super Professional
Some Company Name | Berlin (DE)
http://www.example.com
- Lorem ipsum dolor sit amet, consectetur adipiscing elit
- Lorem ipsum dolor sit amet, consectetur adipiscing elit
- Lorem ipsum dolor sit amet, consectetur adipiscing elit
```
### Posts
Posts should have at least the following front matter:
```
---
layout: post
title: "Lorem ipsum"
tagline: "Lorem ipsum and a bit more"
image: "/assets/img1.jpg"
---
```
The value for `layout` can be `post`or `project`.
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/mschaeffner/ceevee. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## Development
To set up your environment to develop this theme, run `bundle install`.
Your theme is setup just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.
When your theme is released, only the files in `_layouts`, `_includes`, `_sass` and `assets` tracked with Git will be bundled.
To add a custom directory to your theme-gem, please edit the regexp in `ceevee.gemspec` accordingly.
## License
The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).