README.md 5.42 KB
Newer Older
Marcia Ramos's avatar
Marcia Ramos committed
1
![Jekyll Version](https://img.shields.io/badge/Jekyll-3.1.2-red.svg)
2
![Build Status](https://gitlab.com/jekyll-themes/default-bundler/badges/master/build.svg)
Marcia Ramos's avatar
Marcia Ramos committed
3 4 5

----

Lorenzo's avatar
Lorenzo committed
6
View Demo: https://lorepirri.gitlab.io/jekyll-theme-simple-blog/
7 8

-----
Lorenzo's avatar
Lorenzo committed
9
# Simple Blog Theme
10

Lorenzo's avatar
Lorenzo committed
11
*Simple Blog is a Jekyll theme for Gitlab or GitHub Pages. It is based on [Cayman Blog Theme](https://github.com/lorepirri/cayman-blog). You can [preview the theme to see what it looks like](https://lorepirri.gitlab.io/jekyll-theme-simple-blog/), or even [use it today](#install).*
12

Lorenzo's avatar
Lorenzo committed
13
<img src="https://gitlab.com/lorepirri/jekyll-theme-simple-blog/raw/master/simple-blog-theme.png" alt="Thumbnail of jekyll-theme-simple-blog" style="max-width:30%; border: 1px solid grey;"/>
14

Lorenzo's avatar
Lorenzo committed
15 16 17 18 19 20
## Features

- Blog
- Responsive
- Minimal
- Multi-language
21 22
- SEO optimized
- Social buttons (instagram, linkedin, twitter, github, gitlab)
Lorenzo's avatar
Lorenzo committed
23 24
- RSS feed multi-language

Lorenzo's avatar
Lorenzo committed
25
## Install
26

Lorenzo's avatar
Lorenzo committed
27
Simple Blog Theme is 100% compatible with GitLab and GitHub Pages.
28

Lorenzo's avatar
Lorenzo committed
29
### Install as a Fork
30

Lorenzo's avatar
Lorenzo committed
31 32 33 34 35 36 37 38 39 40
1. [Fork the repo](https://gitlab.com/lorepirri/jekyll-theme-simple-blog)
2. Clone down the repo with one of the two:
    * ssh `$ git clone [email protected]:your-username/jekyll-theme-simple-blog.git`
    * https: `$ git clone https://gitlab.com/lorepirri/jekyll-theme-simple-blog.git`
3. Empty the `_posts/` folder
4. Install bundler and gems with `$ script/bootstrap`
5. Run Jekyll with `$ script/server`
6. Modify `_config.yml`, `about-en.md`, `contact-en.md`, and the other pages for your project
6. Write your posts in `_posts/en` and `_posts/<other-language>`
7. [Customize the theme](customizing)
41

Lorenzo's avatar
Lorenzo committed
42
### SEO tags
43

Lorenzo's avatar
Lorenzo committed
44
Simple Blog includes simple SEO tags from [jekyll-social-metatags](https://github.com/lorepirri/jekyll-social-metatags). Have a look at the page for its usage.
45

Lorenzo's avatar
Lorenzo committed
46
The usage is compatible with the plugin [Jekyll SEO Tag](https://github.com/jekyll/jekyll-seo-tag), which provides a battle-tested template of crowdsourced best-practices.
47

Lorenzo's avatar
Lorenzo committed
48
To switch to a better SEO tags however, one should install [Jekyll Feed plugin](https://github.com/jekyll/jekyll-feed):
49

Lorenzo's avatar
Lorenzo committed
50
1. Add this line to your site's Gemfile:
51

Lorenzo's avatar
Lorenzo committed
52 53 54
    ```ruby
    gem 'jekyll-seo-tag'
    ```
55

Lorenzo's avatar
Lorenzo committed
56
2. And then add this line to your site's `_config.yml`:
57

Lorenzo's avatar
Lorenzo committed
58 59 60 61
    ```yml
    gems:
      - jekyll-seo-tag
    ```
62

Lorenzo's avatar
Lorenzo committed
63
3. Replace with the following, the `<!-- jekyll-seo-tag -->` comment in your site's `default.html`:
64

Lorenzo's avatar
Lorenzo committed
65 66 67
      ```liquid
      {% seo %}
      ```
68

Lorenzo's avatar
Lorenzo committed
69
For more information about configuring this plugin, see the official [Jekyll SEO Tag](https://github.com/jekyll/jekyll-seo-tag) page.
70 71


Lorenzo's avatar
Lorenzo committed
72
### Stylesheet
73

Lorenzo's avatar
Lorenzo committed
74
If you'd like to add your own custom styles:
75

Lorenzo's avatar
Lorenzo committed
76 77 78 79 80
1. Create a file called `/assets/css/style.scss` in your site
2. Add the following content to the top of the file, exactly as shown:
    ```scss
    ---
    ---
81

Lorenzo's avatar
Lorenzo committed
82 83 84
    @import "{{ site.theme }}";
    ```
3. Add any custom CSS (or Sass, including imports) you'd like immediately after the `@import` line
85

Lorenzo's avatar
Lorenzo committed
86
### Layouts
87

Lorenzo's avatar
Lorenzo committed
88
If you'd like to change the theme's HTML layout:
89

Lorenzo's avatar
Lorenzo committed
90 91 92 93
1. [Copy the original template](https://gitlab.com/lorepirri/jekyll-theme-simple-blog/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
94

Lorenzo's avatar
Lorenzo committed
95
### Sass variables
96

Lorenzo's avatar
Lorenzo committed
97
If you'd like to change the theme's [Sass variables](https://gitlab.com/lorepirri/jekyll-theme-simple-blog/blob/master/_sass/variables.scss), set new values before the `@import` line in your stylesheet:
98

Lorenzo's avatar
Lorenzo committed
99 100
```scss
$section-headings-color: #0086b3;
101

Lorenzo's avatar
Lorenzo committed
102 103
@import "{{ site.theme }}";
```
104

Lorenzo's avatar
Lorenzo committed
105
## Roadmap
106

Lorenzo's avatar
Lorenzo committed
107
See the [open issues](https://gitlab.com/lorepirri/jekyll-theme-simple-blog/issues) for a list of proposed features (and known issues).
108

Lorenzo's avatar
Lorenzo committed
109
## Project philosophy
110

Lorenzo's avatar
Lorenzo committed
111
The Simple Blog Theme is intended to make it quick and easy for Gitlab or 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.
112

Lorenzo's avatar
Lorenzo committed
113
## Contributing
114

Lorenzo's avatar
Lorenzo committed
115
Interested in contributing to Simple Blog? We'd love your help. Simple Blog 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.
116

Lorenzo's avatar
Lorenzo committed
117
### Previewing the theme locally
118

Lorenzo's avatar
Lorenzo committed
119
If you'd like to preview the theme locally (for example, in the process of proposing a change):
120

Lorenzo's avatar
Lorenzo committed
121 122 123 124 125
1. Clone down the theme's repository (`git clone https://gitlab.com/lorepirri/jekyll-theme-simple-blog`)
2. `cd` into the theme's directory
3. Run `script/bootstrap` to install the necessary dependencies
4. Run `script/server` to start the preview server
5. Visit [`localhost:4000`](http://localhost:4000) in your browser to preview the theme
126 127


Marcia Ramos's avatar
Marcia Ramos committed
128 129 130 131
[`.gitlab-ci.yml`]: https://gitlab.com/jekyll-themes/default-bundler/blob/master/.gitlab-ci.yml
[`Gemfile`]: https://gitlab.com/jekyll-themes/default-bundler/blob/master/Gemfile
[`.gitignore`]: https://gitlab.com/jekyll-themes/default-bundler/blob/master/.gitignore
[`_config.yml`]: https://gitlab.com/jekyll-themes/default-bundler/blob/master/_config.yml
132 133

[Bundler]: http://bundler.io/
Marcia Ramos's avatar
Marcia Ramos committed
134 135
[Jekyll]: http://jekyllrb.com/
[jek-312]: https://rubygems.org/gems/jekyll/versions/3.1.2