Skip to content

Commit

Permalink
Added README.
Browse files Browse the repository at this point in the history
  • Loading branch information
thomasvaeth committed Feb 19, 2018
1 parent ee89c94 commit 3f5dbca
Show file tree
Hide file tree
Showing 13 changed files with 213 additions and 16 deletions.
196 changes: 196 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,196 @@
# Barber
Barber is a minimal blog theme built for Jekll. The blog theme features a masonry grid, endless scrolling, and page transitions. 💈 Barber is also available for [Ghost](https://github.com/samesies/barber-ghost).

## Initial Setup
* [Installation](#installation)
* [Update Settings](#update-settings)
* [Create Posts](#create-posts)
* [Create Pages](#create-pages)
* [Create Navigation](#create-navigation)

## Customization
* [Contact Form](#contact-form)
* [Social Media Links](#social-media-links)
* [Disqus Comments](#disqus-comments)

## Additional Development
* [Source Code](#source-code)
* [Donations](#donations)
* [Support](#support)

### Installation
Jekyll requires all dependencies to be saved in the ````Gemfile````. Run ````bundle install```` (Install [Bundler](http://bundler.io/) if it is not already) on your command line after downloading or cloning the theme. You can then run ````bundle exec jekyll serve```` or ````npm start```` to see your development site. Run ````bundle exec jekyll build```` or ````npm run build```` to build a production ready site for deployment.

### Update Settings
Almost everything to personalize your site is in the ````_config.yml````.

```
# Site/SEO settings
email: [email protected]
baseurl: ""
paginate: 12
paginate_path: "/page/:num"
permalink: /:year/:month/:day/:title/
google_analytics:
name: Thomas Vaeth
title: The Barber Theme
description: >
Barber is a blog theme for Jekyll built by Thomas Vaeth for Samesies using HTML, Sass, and JavaScript.
url: http://barber.samesies.io
twitter_username: thomasvaeth
default_img: /assets/images/seo.jpg
contact_img: /assets/images/placeholder-28.jpg
social:
- name: twitter
url: https://twitter.com/thomasvaeth
- name: instagram
url: https://www.instagram.com/thomas.vaeth/
- name: linkedin
url: https://www.linkedin.com/in/thomasvaeth/
- name: github
url: https://github.com/samesies
- name: codepen
url: https://codepen.io/thomasvaeth/
# Disqus settings
disqus: test-apkdzgmqhj
# MailChimp settings
mailchimp_action: https://samesies.us17.list-manage.com/subscribe/post-json?u=66ddf555dab480e6a8606430b&id=89b3ee034f
mailchimp_input: b_66ddf555dab480e6a8606430b_89b3ee034f
# Author settings
author:
- name: Thomas Vaeth
bio: Thomas Vaeth was born in New York, raised in Pennsylvania, and transplanted in Washington. He was a Web Developer at Urban Influence, but now he's a Software Engineer at Getty Images.
url: http://thomasvaeth.com
```

You can change the email address the [contact form](#contact-form) is sent to, add Google Analytics, change the SEO settings, grow your website with additional authors, and much more.

### Create Posts
All posts go upder the ````_posts```` directory. You can also have a ````_drafts```` directory with posts that will on your development page, but not in production.

```
---
layout: post
title: "Brunch Swag"
date: 2017-02-18
description:
image: /assets/images/placeholder-15.jpg
author: Thomas Vaeth
tags:
- XOXO
- La Croix
---
```

The front matter has to have a layout of page. All the other fields are completely optional. If you have an ````author```` variable, then it must match an author's name in ````_config.yml```` (see [Update Settings](#update-settings)). The ````tag```` variable will add a related section to the post and popular tags to the footer.

### Create Pages
Creating a static page is the same as creating a post. The only difference is a page is in the root of the directory rather than the ````_posts```` directory.

```
---
layout: page
title: Style Guide
image: /assets/images/placeholder-18.jpg
---
```

You just have to make sure the front matter has a layout of page instead of post. If there is no title or image, then the page will default to the site configuration.

### Create Navigation
You can create a navigation in ````_includes/navigation.html````. Visitors can be linked directly to pages right on the top of your website.

***

### Contact Form
The form uses [Formspree](https://formspree.io/) to send submitted messages straight to your inbox. The image on the popup is the the ````contact_img```` variable and them email the forms sends to is the ````email```` variable in ````_config.yml```` (see [Update Settings](#update-settings)).

![Contact Form](http://samesies.io/assets/images/barber/doc/framed-contact-form.jpg "Contact Form")

You do have to set the email address where you want to receive the form (you can even set the subject too). This file can be found in ````_includes/formspree.hbs````. You can change the subject of the email or the labels of the form here. After everything is set you will need to submit a message to yourself to confirm the email address is correct.

### Social Media Links
[Font Awesome](http://fontawesome.io/) is used for the social media icons. The icons in the theme can be found in ````_includes/share.html```` and ````_includes/social.html````. The icons in ````_includes/share.html```` do not need to be edited unless you want to remove a certain website; however, the ones in ````_includes/social.html```` do have to be changed. You can follow the example that has been provided in ````_config.yml```` for you to link to all of your social media accounts (see [Update Settings](#update-settings)). The naming convention has not changed from the instructions provided on Font Awesome.

### Disqus Comments
Comments can be enabled on every blog post in a few steps steps. The first step is to register your website with [Disqus](https://disqus.com/). Disqus will provide you with a shortname that you need for the next step. Once you have that the second step is to replace the ````disqus```` variable in ````_config.yml```` (see [Update Settings](#update-settings)). The third step is to open ````_includes/disqus.html```` and remove all the instructions. The final step is to visit a blog post and verify that your comments are there.

***

### Source Code
The source code is broken down to make finding what you need as easy as possible. Almost everything runs through ````gulpfile.js````, so you will need to run ````npm install```` on your command line before doing any additional development. You can then run ````gulp```` or ````npm run gulp```` to compile everything.

```
.
├── _assets
| ├── js
| ├── components
| ├── vendor
| ├── _inits.js
| └── app.js
| └── scss
| ├── base
| ├── components
| ├── fonts
| ├── regions
| ├── tools
| ├── utils
| ├── vendor
| └── app.scss
├── _includes
| ├── contact.html
| ├── disqus.html
| ├── footer.html
| ├── formspree.html
| ├── head.html
| ├── header.html
| ├── navigation.html
| ├── pagination.html
| ├── post-card.html
| ├── share.html
| ├── social.html
| └── subscribe_form.html
├── _layouts
| ├── compress.html
| ├── default.html
| ├── page.html
| ├── post.html
| └── tag.html
├── _plugins
├── _posts
├── _site
├── assets
| ├── css
| ├── images
| ├── js
├── .eslintrc
├── .gitignore
├── .stylelintrc
├── 404.html
├── _config.yml
├── Gemfile
├── Gemfile.lock
├── gulpfile.js
├── index.html
├── package.json
├── README.md
├── style-guidle.html
└── subscribe.html
```

The CSS is written in Sass. The JavaScript is written in ES6, so your code is up to date with the newest standards.

### Donations
Barber has been released for free. Similar themes cost around $29 on [ThemeForest](https://themeforest.net/category/static-site-generators/jekyll). Any donations would be greatly appreciated after the work that went into releasing Barber.

* PayPal – <https://www.paypal.me/samesies>
* Bitcoin – 1PSzNmcfAFJY1PtBK5u9R5bTGfF7KAuLcq
* Ethereum – 0x392F7116e4171F1D740397B6000EadD2e4bb9670
* Litecoin – LSH9AnjcUTV5T7PUxXQuxPqb9W5aSR9GEP

### Support
Email <[email protected]> if you need any additional support with Barber.
1 change: 0 additions & 1 deletion _assets/scss/components/_related.scss
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
// Mast
//----------------------------------------------
.related {
border-top: $border;
background-color: $color-lightgrey;

&__title {
Expand Down
2 changes: 0 additions & 2 deletions _assets/scss/regions/_footer.scss
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,4 @@ main {

// flex-grow: 1;
margin-top: $header-height;

background-color: $color-white;
}
11 changes: 7 additions & 4 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -1,18 +1,19 @@
# Site settings
# Site/SEO settings
email: [email protected]
baseurl: ""
paginate: 12
paginate_path: "/page/:num"
permalink: /:year/:month/:day/:title/
google_analytics:

# SEO settings
name: Thomas Vaeth
title: The Barber Theme
description: >
Barber is a blog theme for Jekyll built by Thomas Vaeth for Samesies using HTML, Sass, and JavaScript.
url: "http://barber.samesies.io"
url: http://barber.samesies.io
twitter_username: thomasvaeth
default_img: /assets/images/seo.jpg
contact_img: /assets/images/placeholder-28.jpg
social:
- name: twitter
url: https://twitter.com/thomasvaeth
Expand All @@ -25,6 +26,9 @@ social:
- name: codepen
url: https://codepen.io/thomasvaeth/

# Disqus settings
disqus: test-apkdzgmqhj

# MailChimp settings
mailchimp_action: https://samesies.us17.list-manage.com/subscribe/post-json?u=66ddf555dab480e6a8606430b&amp;id=89b3ee034f
mailchimp_input: b_66ddf555dab480e6a8606430b_89b3ee034f
Expand All @@ -37,7 +41,6 @@ author:

# Build settings
markdown: kramdown
permalink: /:year/:month/:day/:title/
plugins:
- jekyll-paginate
- jekyll-sitemap
Expand Down
2 changes: 1 addition & 1 deletion _includes/contact.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
</div>
<div class="contact__container popup__container">
<div class="contact__img">
<figure class="absolute-bg" style="background-image: url({{ '/assets/images/placeholder-28.jpg' | absolute_url }});"></figure>
<figure class="absolute-bg" style="background-image: url({{ site.contact_img | prepend: site.baseurl }});"></figure>
</div>
<div class="contact__content">
<div class="contact__mast section-padding--half">
Expand Down
2 changes: 1 addition & 1 deletion _includes/disqus.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
};
(function() {
var d = document, s = d.createElement('script');
s.src = 'https://test-apkdzgmqhj.disqus.com/embed.js';
s.src = 'https://{{ site.disqus }}.disqus.com/embed.js';
s.setAttribute('data-timestamp', +new Date());
(d.head || d.body).appendChild(s);
})();
Expand Down
2 changes: 1 addition & 1 deletion _includes/formspree.html
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<form id="form" class="form" action="https://formspree.io/[email protected]" method="POST">
<form id="form" class="form" action="https://formspree.io/{{ site.email }}" method="POST">
<input type="hidden" name="_subject" value="Someone Emailed You. 💈">
<div class="form__subcontainer">
<div>
Expand Down
4 changes: 2 additions & 2 deletions _includes/navigation.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<nav>
<ul class="header__list">
<li><a href="{{ '/' | absolute_url }}">Stories</a></li>
<li><a href="{{ '/style-guide' | absolute_url }}">Style Guide</a></li>
<li><a href="{{ '/' | prepend: site.baseurl }}">Stories</a></li>
<li><a href="{{ '/style-guide' | prepend: site.baseurl }}">Style Guide</a></li>
<li><span class="popup__open">Contact</span></li>
</ul>
</nav>
2 changes: 1 addition & 1 deletion _posts/2017-10-08-brunch-swag.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ date: 2017-10-08
description:
image: /assets/images/placeholder-15.jpg
author: Thomas Vaeth
tags:
tags:
---
Church-key XOXO try-hard, schlitz kickstarter meh marfa sustainable yuccie you probably haven't heard of them. Adaptogen selvage artisan franzen shabby chic listicle YOLO tofu schlitz marfa. Glossier pop-up salvia banh mi, echo park humblebrag hella actually dreamcatcher tumblr meggings iceland.

Expand Down
2 changes: 1 addition & 1 deletion _posts/2017-10-09-lumbersexual.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ date: 2017-10-09
description:
image: /assets/images/placeholder-3.jpg
author: Thomas Vaeth
tags:
tags:
---
Umami thundercats 90's chia tumblr. [Dreamcatcher](http://thomasvaeth.com/) cronut neutra forage lo-fi. +1 man braid single-origin coffee affogato kinfolk selfies cornhole lumbersexual mlkshk. Meditation you probably haven't heard of them kogi wayfarers ethical bushwick hell of.

Expand Down
2 changes: 1 addition & 1 deletion assets/css/app.min.css

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion assets/js/app.min.js

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"version": "1.0.0",
"scripts": {
"start": "bundle exec jekyll serve",
"build": "bundle exec jekyll build",
"deploy": "gulp build && bundle exec jekyll build && s3-website deploy _site",
"gulp": "gulp"
},
Expand Down

0 comments on commit 3f5dbca

Please sign in to comment.