Skip to content

Latest commit

 

History

History
72 lines (58 loc) · 2.6 KB

README.md

File metadata and controls

72 lines (58 loc) · 2.6 KB
Raw

jekyll-starter-bulma

Quickly get a jekyll website up and going with bulma css, a smart directory structure, and community standard seo practices

jekyll-starter-bulma

Features

  • Barebons Jekyll Setup
  • Bulma CSS framework
  • Community Standard SEO practices
  • Seperate pages and news directory. (Put all your pages in separate directories for tidy-ness)
  • Customizable permalinks
  • Starter config, header, template, css and footer files
  • Plugin Free!
  • Sitemap.xml generator
  • Google Analytics Integration & Formspree
  • Animate.css

Installation

  1. git clone https://github.com/garrettbland/jekyll-starter-bulma.git
  2. cd jekyll-starter-bulma
  3. jekyll serve or jekyll build

Getting Started

Refer here for documentation

Getting your site ready for production

  1. Open up your project in terminal
  2. Make sure jekyll serve is not running
  3. Run JEKYLL_ENV=production jekyll build. It is important to get the environment variable set to production. This will include the analytics file to start tracking page visits

Adding Google Analytics

  1. Change trackingID in _confi.yml and replace UA-XXXXXXXXX-Y
  2. Once you build your site with the environment flag set to production, your site will start tracking visits. See "Getting your site ready for production" above for environment details

Adding a new page

  1. Create a new directory inside _pages. Lets call it contact
  2. Create a new file inside your new directory called index.html
  3. Copy the YAML front matter below into your new file. Reload your page and navigate to http://127.0.0.1:4000/contact/ to see your new page in action
  4. Add in your html below the front matter
---
layout: default
title: "Contact"
description: "Contact us page. Also meta descriptions"
socialimage: "/img/social-image-contact.jpg"
permalink: "/contact/"
---

Adding a new post

  1. Create a new file inside _news. Lets call it article.md (or .html)
  2. Copy the YAML front matter below into your new file. Reload your page and navigate to http://127.0.0.1:4000/news/article/ to see your new post in action
  3. Add in your html below the front matter
---
layout: default
title: "Garretts News Article"
description: "Some awesome news about Garrett. He just learned how to create stuff."
socialimage: "/img/social-image-about.jpg"
---

Status

This is still a work in progress. If you see something that could be added or changed for the better, please send me a pull request!

New to Jekyll?

Get started here https://jekyllrb.com/docs/installation/