Skip to content

Commit 3780a88

Browse files
committed
theme
1 parent d5e3a28 commit 3780a88

File tree

875 files changed

+852
-28956
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

875 files changed

+852
-28956
lines changed

404.html

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
layout: default
3+
---
4+
5+
<style type="text/css" media="screen">
6+
.container {
7+
margin: 10px auto;
8+
max-width: 600px;
9+
text-align: center;
10+
}
11+
h1 {
12+
margin: 30px 0;
13+
font-size: 4em;
14+
line-height: 1;
15+
letter-spacing: -1px;
16+
}
17+
</style>
18+
19+
<div class="container">
20+
<h1>404</h1>
21+
22+
<p><strong>Page not found :(</strong></p>
23+
<p>The requested page could not be found.</p>
24+
</div>

CODE_OF_CONDUCT.md

+74
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, gender identity and expression, level of experience,
9+
nationality, personal appearance, race, religion, or sexual identity and
10+
orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at [email protected]. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at [http://contributor-covenant.org/version/1/4][version]
72+
73+
[homepage]: http://contributor-covenant.org
74+
[version]: http://contributor-covenant.org/version/1/4/

Gemfile

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# frozen_string_literal: true
2+
3+
source "https://rubygems.org"
4+
gemspec
5+
6+
gem "jekyll", ENV["JEKYLL_VERSION"] if ENV["JEKYLL_VERSION"]

LICENSE.txt

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2019 Jekyll lin contributors
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in
13+
all copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21+
THE SOFTWARE.

README.md

100644100755
+184-13
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,192 @@
1-
Jekyll Themes
2-
=============
1+
# Jekyll lin theme
32

4-
A directory of the best-looking themes for Jekyll blogs
3+
A slick minimalist theme for Jekyll built with [lin.css](https://lin-css.netlify.com/).
54

5+
[Theme preview](https://jekyll-lin-theme.netlify.com)
66

7-
Submitting a Theme
8-
------------------
7+
## Quick start
98

10-
Have a theme you want to share?
9+
1. Fork the this repository
10+
2. Update the `_config.yml` file with your settings
11+
3. Update the content at the `_posts` folder and the pages at the root (`about.md`, `contact.md`)
12+
4. Commit and push the changes to your repository and follow the instructions to deploy your website to:
13+
- [Github pages](https://jekyllrb.com/docs/github-pages/)
14+
- or [Netlify](https://www.netlify.com/blog/2017/05/11/migrating-your-jekyll-site-to-netlify/)
1115

12-
* Fork the site on GitHub
13-
* Create a new post in the `_posts` directory and fill out the relevant YAML fields
14-
* Make a 250x200 thumbnail and drop it in the thumbnails directory. List its filename in the post's markdown file.
15-
* Test it out, then push your changes up and open a pull request.
1616

17+
## Installation
1718

18-
License
19-
-------
19+
Add this line to your Jekyll site's Gemfile:
2020

21-
The contents of this repository are licensed under the [GNU Public License.](http://www.gnu.org/licenses/gpl-3.0.html)
21+
```ruby
22+
gem "jekyll-lin"
23+
```
24+
25+
And then execute:
26+
27+
$ bundle
28+
29+
30+
### Layouts
31+
32+
Refers to files within the `_layouts` directory, that define the markup for your theme.
33+
34+
- `default.html` &mdash; The base layout that lays the foundation for subsequent layouts. The derived layouts inject their contents into this file at the line that says ` {{ content }} ` and are linked to this file via [FrontMatter](https://jekyllrb.com/docs/frontmatter/) declaration `layout: default`.
35+
- `home.html` &mdash; The layout for your landing-page / home-page / index-page. [[More Info.](#home-layout)]
36+
- `page.html` &mdash; The layout for your documents that contain FrontMatter, but are not posts.
37+
- `post.html` &mdash; The layout for your posts.
38+
39+
#### Home Layout
40+
41+
`home.html` is a flexible HTML layout for the site's landing-page / home-page / index-page. <br/>
42+
43+
### Includes
44+
45+
Refers to snippets of code within the `_includes` directory that can be inserted in multiple layouts (and another include-file as well) within the same theme-gem.
46+
47+
- `disqus_comments.html` &mdash; Code to markup disqus comment box.
48+
- `footer.html` &mdash; Defines the site's footer section.
49+
- `google-analytics.html` &mdash; Inserts Google Analytics module (active only in production environment).
50+
- `head.html` &mdash; Code-block that defines the `<head></head>` in *default* layout.
51+
- `header.html` &mdash; Defines the site's main header section. By default, pages with a defined `title` attribute will have links displayed here.
52+
- `social.html` &mdash; Renders social-media icons based on the `lin:social_links` data in the config file.
53+
54+
55+
### Assets
56+
57+
Refers to various asset files within the `assets` directory.
58+
Contains the `css/style.scss` that imports sass files from within the `_sass` directory. This `css/style.scss` is what gets processed into the theme's main stylesheet `main.css` called by `_layouts/default.html` via `_includes/head.html`.
59+
60+
This directory can include sub-directories to manage assets of similar type (`img`, `fonts`, `svg`), and will be copied over as is, to the final transformed site directory.
61+
62+
## Usage
63+
64+
Have the following line in your config file:
65+
66+
```yaml
67+
theme: jekyll-lin
68+
```
69+
70+
71+
### Customizing templates
72+
73+
To override the default structure and style of minima, simply create the concerned directory at the root of your site, copy the file you wish to customize to that directory, and then edit the file.
74+
e.g., to override the [`_includes/head.html `](_includes/head.html) file to specify a custom style path, create an `_includes` directory, copy `_includes/head.html` from minima gem folder to `<yoursite>/_includes` and start editing that file.
75+
76+
The site's default CSS has now moved to a new place within the gem itself, [`assets/css/style.scss`](assets/css/style.scss). To **override the default CSS**, the file has to exist at your site source. Do either of the following:
77+
- Create a new instance at site source.
78+
- Create a new file at `<your-site>/assets/css/style.scss`
79+
- Add the frontmatter dashes, and
80+
- Add `@import "minima";`
81+
- Add your custom CSS.
82+
- Download the file from this repo
83+
- Create a new file at `<your-site>/assets/css/style.scss`
84+
- Copy the contents at [assets/css/style.scss](assets/css/style.scss) onto the `css/style.scss` you just created, and edit away!
85+
- Copy directly from minima gem
86+
- Go to your local minima gem installation directory ( run `bundle show minima` to get the path to it ).
87+
- Copy the `assets/` folder from there into the root of `<your-site>`
88+
- Change whatever values you want, inside `<your-site>/assets/css/style.scss`
89+
90+
### Change default date format
91+
92+
You can change the default date format by specifying `site.lin.date_format`
93+
in `_config.yml`.
94+
95+
### Add your favicons
96+
97+
1. Head over to [https://realfavicongenerator.net/](https://realfavicongenerator.net/) to add your own favicons.
98+
2. [Customize](#customization) default `_includes/head.html` in your source directory and insert the given code snippet.
99+
100+
### Enabling comments (via Disqus)
101+
102+
Optionally, if you have a Disqus account, you can tell Jekyll to use it to show a comments section below each post.
103+
104+
To enable it, add the following lines to your Jekyll site:
105+
106+
```yaml
107+
disqus:
108+
shortname: my_disqus_shortname
109+
```
110+
111+
You can find out more about Disqus' shortnames [here](https://help.disqus.com/installation/whats-a-shortname).
112+
113+
Comments are enabled by default and will only appear in production, i.e., `JEKYLL_ENV=production`
114+
115+
If you don't want to display comments for a particular post you can disable them by adding `comments: false` to that post's YAML Front Matter.
116+
117+
:warning: `url`, e.g. `https://example.com`, must be set in you config file for Disqus to work.
118+
119+
120+
### Social networks
121+
122+
You can add links to the accounts you have on other sites, with respective icon, by adding one or more of the following options in your config.
123+
From `Minima-3.0` onwards, the usernames are to be nested under `lin.social_links`, with the keys being simply the social-network's name:
124+
125+
```yaml
126+
minima:
127+
social_links:
128+
twitter: jekyllrb
129+
github: jekyll
130+
medium: jekyll
131+
rss: rss
132+
dribbble: jekyll
133+
facebook: jekyll
134+
flickr: jekyll
135+
instagram: jekyll
136+
linkedin: jekyll
137+
pinterest: jekyll
138+
youtube_user: jekyll
139+
youtube_channel: UC8CXR0-3I70i1tfPg1PAE1g
140+
telegram: jekyll
141+
googleplus: +jekyll
142+
keybase: jekyll
143+
```
144+
145+
### Enabling Google Analytics
146+
147+
To enable Google Analytics, add the following lines to your Jekyll site:
148+
149+
```yaml
150+
google_analytics: UA-NNNNNNNN-N
151+
```
152+
153+
Google Analytics will only appear in production, i.e., `JEKYLL_ENV=production`
154+
155+
### Enabling Excerpts on the Home Page
156+
157+
To display post-excerpts on the Home Page, simply add the following to your `_config.yml`:
158+
159+
```yaml
160+
show_excerpts: true
161+
```
162+
163+
164+
## Contributing
165+
166+
Bug reports and pull requests are welcome on GitHub at [https://github.com/ssokurenko/jekyll-lin-theme](https://github.com/ssokurenko/jekyll-lin-theme). 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.
167+
168+
## Development
169+
170+
To set up your environment to develop this theme, run `script/bootstrap`.
171+
172+
To test your theme, run `script/server` (or `bundle exec jekyll serve`) and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme and the contents. As you make modifications, your site will regenerate and you should see the changes in the browser after a refresh.
173+
174+
## Publishing
175+
176+
Update the version.
177+
178+
Build the gem:
179+
180+
```
181+
gem build jekyll-lin.gemspec
182+
```
183+
184+
Push the generated file
185+
186+
```
187+
gem push jekyll-lin-x.y.z.gem
188+
```
189+
190+
## License
191+
192+
The theme is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

_config.yml

100644100755
+35-11
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,40 @@
1-
name: Jekyll Themes
2-
url: http://matt.harzewski.com
3-
description: Insert tagline here
1+
title: Your awesome title
2+
author: GitHub User
3+
4+
copyright: © 2019 GitHub User
5+
description: > # this means to ignore newlines until "show_excerpts:"
6+
Write an awesome description for your new site here. You can edit this
7+
line in _config.yml. It will appear in your document head meta (for
8+
Google search results) and in your feed.xml site description.
49
5-
permalink: /themes/:title/
10+
show_excerpts: false # set to true to show excerpts on the homepage
611

7-
plugins: [jekyll-paginate]
12+
lin:
13+
date_format: "%b %-d, %Y"
814

9-
highlighter: pygments
10-
paginate: 20
15+
# path to the author avatar image
16+
avatar_path: assets/images/avatar.jpg
1117

12-
markdown: rdiscount
13-
rdiscount:
14-
extensions: ['smart']
18+
# generate social links
19+
social_links:
20+
twitter: jekyllrb
21+
github: jekyll
22+
medium: jekyll
23+
rss: rss
24+
dribbble: jekyll
25+
facebook: jekyll
26+
flickr: jekyll
27+
instagram: jekyll
28+
linkedin: jekyll
29+
pinterest: jekyll
30+
youtube_user: jekyll
31+
youtube_channel: UC8CXR0-3I70i1tfPg1PAE1g
32+
telegram: jekyll
33+
googleplus: +jekyll
34+
keybase: jekyll
1535

16-
exclude: ['README.md', 'Gemfile.lock', 'Gemfile', 'Rakefile', 'vendor']
36+
theme: lin
37+
38+
plugins:
39+
- jekyll-feed
40+
- jekyll-seo-tag

_includes/avatar.html

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
<div>
2+
<img class="lin-image is-round" src="{{ site.lin.avatar_path | escape }}" alt="{{ site.author | escape }}">
3+
</div>

0 commit comments

Comments
 (0)