Coder Social home page Coder Social logo

jekyll-starter's Introduction

jekyll-starter

A super-simple starter kit for a bare-bones Jekyll instance. To use, just install Jekyll (if you haven't already):

gem install jekyll

... then:

mkdir my-new-blog; cd my-new-blog
git clone git://github.com/cnunciato/jekyll-starter.git .

... and then finally:

jekyll --server

Then open your browser and hit http://localhost:5000.

That'll get you a home page and one post. The rest is all you! See the Jekyll docs for details.

Keep in mind that at this point, you'll have a cloned version of my repository, which you might not want. To start fresh with a commit history of your own (which I'd recommend, unless you plan on contributing to this project), do this from the root of my-new-blog:

rm -rf .git
git init
git add .
git commit -am "my first commit"

What This Actually Does

All this kit does is set you up with the typical Jekyll directory structure, a sample index.html file, a sample post, a shared header and footer, and a couple of tweaks to the default configuration (port 5000, auto-regenerate true). That's it -- no categories, no tags, no Twitter or Disqus integration, no fanciness. Deliberately simple, just the basics. I know I wanted this when I first got started with Jekyll, so here it is -- hopefully helpful to you, too.

To create a new post, just:

touch _posts/yyyy-mm-dd-url-friendly-title.markdown

... where yyyy-mm-dd is a date (e.g., 2012-08-31) and url-friendly-title is, well, a URL-friendly title. Then inside that post, be sure to add at least the minimal YAML front matter (see the _posts folder for an example):

---
layout: post
title: "My Second Post"
---

It was a dark and stormy night...

Enjoy.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.