Git Product home page Git Product logo

March, 2016: If you're on an old version of Jekyll Now and run into a) build warnings or b) syntax highlighting issues caused by Jekyll 3 and GitHub Pages updates, just โœจupdate your _config.ymlโœจ and you'll be set!

Jekyll Now

Jekyll is a static site generator that's perfect for GitHub hosted blogs (Jekyll Repository)

Jekyll Now makes it easier to create your Jekyll blog, by eliminating a lot of the up front setup.

  • You don't need to touch the command line
  • You don't need to install/configure ruby, rvm/rbenv, ruby gems โ˜บ๏ธ
  • You don't need to install runtime dependencies like markdown processors, Pygments, etc
  • If you're on Windows, this will make setting up Jekyll a lot easier
  • It's easy to try out, you can just delete your forked repository if you don't like it

In a few minutes you'll be set up with a minimal, responsive blog like the one below giving you more time to spend on writing epic blog posts!

Jekyll Now Theme Screenshot

Quick Start

Step 1) Fork Jekyll Now to your User Repository

Fork this repo, then rename the repository to yourgithubusername.github.io.

Your Jekyll blog will often be viewable immediately at http://yourgithubusername.github.io (if it's not, you can often force it to build by completing step 2)

Step 1

Step 2) Customize and view your site

Enter your site name, description, avatar and many other options by editing the _config.yml file. You can easily turn on Google Analytics tracking, Disqus commenting and social icons here too.

Making a change to _config.yml (or any file in your repository) will force GitHub Pages to rebuild your site with jekyll. Your rebuilt site will be viewable a few seconds later at http://yourgithubusername.github.io - if not, give it ten minutes as GitHub suggests and it'll appear soon

There are 3 different ways that you can make changes to your blog's files:

  1. Edit files within your new username.github.io repository in the browser at GitHub.com (shown below).
  2. Use a third party GitHub content editor, like Prose by Development Seed. It's optimized for use with Jekyll making markdown editing, writing drafts, and uploading images really easy.
  3. Clone down your repository and make updates locally, then push them to your GitHub repository.

_config.yml

Step 3) Publish your first blog post

Edit /_posts/2014-3-3-Hello-World.md to publish your first blog post. This Markdown Cheatsheet might come in handy.

First Post

You can add additional posts in the browser on GitHub.com too! Just hit the + icon in /_posts/ to create new content. Just make sure to include the front-matter block at the top of each new blog post and make sure the post's filename is in this format: year-month-day-title.md

Local Development

  1. Install Jekyll and plug-ins in one fell swoop. gem install github-pages This mirrors the plug-ins used by GitHub Pages on your local machine including Jekyll, Sass, etc.
  2. Clone down your fork git clone https://github.com/yourusername/yourusername.github.io.git
  3. Serve the site and watch for markup/sass changes jekyll serve
  4. View your website at http://127.0.0.1:4000/
  5. Commit any changes and push everything to the master branch of your GitHub user repository. GitHub Pages will then rebuild and serve your website.

Moar!

I've created a more detailed walkthrough, Build A Blog With Jekyll And GitHub Pages over at the Smashing Magazine website. Check it out if you'd like a more detailed walkthrough and some background on Jekyll. ๐Ÿค˜

It covers:

  • A more detailed walkthrough of setting up your Jekyll blog
  • Common issues that you might encounter while using Jekyll
  • Importing from Wordpress, using your own domain name, and blogging in your favorite editor
  • Theming in Jekyll, with Liquid templating examples
  • A quick look at Jekyll 2.0โ€™s new features, including Sass/Coffeescript support and Collections

Jekyll Now Features

โœ“ Command-line free fork-first workflow, using GitHub.com to create, customize and post to your blog
โœ“ Fully responsive and mobile optimized base theme (Theme Demo)
โœ“ Sass/Coffeescript support using Jekyll 2.0
โœ“ Free hosting on your GitHub Pages user site
โœ“ Markdown blogging
โœ“ Syntax highlighting
โœ“ Disqus commenting
โœ“ Google Analytics integration
โœ“ SVG social icons for your footer
โœ“ 3 http requests, including your avatar

โœ˜ No installing dependencies โœ˜ No need to set up local development
โœ˜ No configuring plugins
โœ˜ No need to spend time on theming
โœ˜ More time to code other things ... wait โœ“!

Questions?

Open an Issue and let's chat!

Other forkable themes

You can use the Quick Start workflow with other themes that are set up to be forked too! Here are some of my favorites:

Credits

Contributing

Issues and Pull Requests are greatly appreciated. If you've never contributed to an open source project before I'm more than happy to walk you through how to create a pull request.

You can start by opening an issue describing the problem that you're looking to resolve and we'll go from there.

I want to keep Jekyll Now as minimal as possible. Every line of code should be one that's useful to 90% of the people using it. Please bear that in mind when submitting feature requests. If it's not something that most people will use, it probably won't get merged. ๐Ÿ’‚โ€โ™‚๏ธ

zhangpeihao's Projects

freetype-go icon freetype-go

Automatically exported from code.google.com/p/freetype-go

game-of-life icon game-of-life

Demo application for the 'Jenkins: The Definitive Guide' book

gin icon gin

Gin is a HTTP web framework written in Go (Golang). It features a Martini-like API with much better performance -- up to 40 times faster. If you need smashing performance, get yourself some Gin.

gitea icon gitea

Gitea: Git with a cup of tea

gjson icon gjson

Get JSON values quickly - JSON Parser for Go

go-astilectron icon go-astilectron

Build cross platform GUI apps with GO and HTML/JS/CSS (powered by Electron)

go-callvis icon go-callvis

Visualize call graph of your Go program using dot format.

go-chassis icon go-chassis

Go-Chassis is a Software Development Kit(SDK) for rapid development of microservices in Go

go-genesis icon go-genesis

Public blockchain platform for building digital ecosystems

go-ice icon go-ice

Interactive Connectivity Establishment following RFC 5245

go-micro icon go-micro

A pluggable RPC framework for microservices

go-oauth2-server icon go-oauth2-server

A standalone, specification-compliant, OAuth2 server written in Golang.

go-tools icon go-tools

A collection of tools and libraries for working with Go code, including linters and static analysis

go-websocket icon go-websocket

Go-WebSocket is a Go implementation of the WebSocket protocol.

go.travis icon go.travis

A script to enable the Go language on Travis CI.

godns icon godns

A fast dns cache server written by go

gogs icon gogs

Gogs(Go Git Service) is a painless self-hosted Git Service.

golang-builder icon golang-builder

Containerized build environment for compiling an executable Golang package and packaging it in a light-weight Docker container.

gopjnath icon gopjnath

Go bindings to PJNATH - ICE, STUN, and TURN Library

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.