Project

bay_jekyll_theme

0.54
A long-lived project that still receives updates
bay_jekyll_themeeliottvincent/bayHomepageDocumentationSource CodeBug Tracker
A simple and minimal Jekyll theme..
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
39,904
Stars
150
Forks
374
Watchers
2
 Releases
Current version
1.1.4
Total releases
28
First release
2019-10-26
Latest release
2024-09-01
 Issues
Open Issues
4
Closed Issues
13
Total Issues
17
Issue Closure Rate
76%
 Pull Requests
Open Pull Requests
2
Closed Pull Requests
20
Merged Pull Requests
8
Pull Request Acceptance Rate
26%
 Development
Primary Language
HTML
Licenses
MIT
Average date of last 50 commits
2022-08-16
Reverse Dependencies
0

 Dependencies

Development

bundler
~> 2.0
jekyll
~> 4.0
 Project Readme

Bay

Version Downloads

Bay is a simple theme for Jekyll. [view live]

Inspired by dangrover.com. Current theme used at eliottvincent.com.

Table of contents

  1. Installation
  2. Website sections
    1. Header
    2. Footer
    3. Home page
    4. Blog page
  3. Development instructions

Installation

The easiest solution is to fork this repo. If you want to start from a clean website, follow the steps below:

Create a new Jekyll website:

jekyll new mysite

Open Gemfile and replace the line:

gem "minima"

with:

gem "bay_jekyll_theme"

Open _config.yml and replace the line:

theme: minima

with:

theme: bay_jekyll_theme

or, for GitHub Pages:

remote_theme: eliottvincent/bay

Finally, install the dependencies:

bundle install

and build the website!

jekyll serve

The website will look somewhat empty at first. That's normal. Follow the next instructions to complete the header and footer components, and the home and blog pages.

Header

Open the _config.yml file and add the following:

header:
  pages:
    - name: Home
      slug: /     # <-- index.md
    - name: Blog  # <-- blog.md
    - name: Whatever  # <-- whatever.md

Re-run jekyll serve to see the header updated.

Footer

Open the _config.yml file and add the following:

footer:
  show_powered_by: true
  contact:
    - type: email
      name: Email
      value: yourmail@domain.com
    - type: wechat
      value: YourWeChatUsername
      link: "#"
  follow:
    - type: twitter
      name: Twitter
      link: http://twitter.com/YourTwitterUsername
      username: "@YourTwitterUsername"
    - type: facebook
      name: Facebook
      link: http://facebook.com/YourFacebookUsername
    - type: linkedin
      name: LinkedIn
      link: http://linkedin.com/in/YourLinkedInUsername
    - type: github
      name: GitHub
      link: http://github.com/YourGitHubUsername
    - type: dribbble
      name: Dribbble
      link: https://dribbble.com/YourDribbbleUsername
    - type: rss
      name: RSS
      link: /feed.xml

Re-run jekyll serve to see the footer updated.

Home page

Create (or edit) the index.markdown file and add the following:

---
layout: home
profile_picture:
  src: /assets/img/profile-pic.jpg
  alt: website picture
---

<p>
  Welcome to mysite!
</p>

Blog page

Create blog.markdown file and add the following:

---
layout: blog
title: Blog
slug: /blog
---

This is an example of a "Blog" page, displaying a list of posts.
<br />

Your website is ready!

Development

Run development instance (with hot-reload)

bundle exec jekyll serve

Build and publish the gem

gem build bay_jekyll_theme.gemspec
gem push bay_jekyll_theme-1.x.x.gem