Top Related Projects
:globe_with_meridians: Jekyll is a blog-aware static site generator in Ruby
:triangular_ruler: Jekyll theme for building a personal site, blog, project documentation, or portfolio.
The Jekyll Butler. A no frills responsive Jekyll blog theme.
✨ Build a beautiful and simple website in literally minutes. Demo at https://beautifuljekyll.com
Github Pages template for academic personal websites, forked from mmistakes/minimal-mistakes
Minimal is a Jekyll theme for GitHub Pages
Quick Overview
Jekyll Now is a template and set of instructions designed to help users quickly set up a Jekyll blog on GitHub Pages. It simplifies the process of creating a Jekyll-powered blog by providing a pre-configured template that can be easily forked and customized.
Pros
- Easy setup process with minimal technical knowledge required
- Immediate deployment on GitHub Pages without local installation
- Customizable design and features through simple configuration files
- Free hosting and automatic version control through GitHub
Cons
- Limited customization options compared to a full Jekyll installation
- Dependency on GitHub for hosting and management
- Potential limitations in scaling for larger or more complex websites
- Less flexibility in terms of plugins and advanced features
Getting Started
- Fork the
barryclark/jekyll-now
repository on GitHub - Rename the repository to
yourusername.github.io
- Customize the
_config.yml
file with your information - Edit
/_posts/2014-3-3-Hello-World.md
to create your first blog post - Push changes to GitHub to see your site live at
https://yourusername.github.io
# _config.yml
name: Your Name
description: Web Developer from Somewhere
avatar: https://raw.githubusercontent.com/barryclark/jekyll-now/master/images/jekyll-logo.png
footer-links:
dribbble:
email:
facebook:
flickr:
github: yourusername
instagram:
linkedin:
pinterest:
rss: # just type anything here for a working RSS icon
twitter: jekyllrb
stackoverflow: # your stackoverflow profile, e.g. "users/50476/bart-kiers"
youtube: # channel/<your_long_string> or user/<user-name>
googleplus: # anything in your profile username that comes after plus.google.com/
Competitor Comparisons
:globe_with_meridians: Jekyll is a blog-aware static site generator in Ruby
Pros of Jekyll
- More comprehensive and feature-rich, offering greater customization options
- Actively maintained with regular updates and a larger community
- Supports plugins, allowing for extended functionality
Cons of Jekyll
- Steeper learning curve, especially for beginners
- Requires more setup and configuration
- May be overkill for simple blog projects
Code Comparison
Jekyll-now:
# Site settings
title: Your Name
description: Web Developer from Somewhere
avatar: https://raw.githubusercontent.com/barryclark/jekyll-now/master/images/jekyll-logo.png
Jekyll:
# _config.yml
title: Your awesome title
email: your-email@example.com
description: >-
Write an awesome description for your new site here.
baseurl: "" # the subpath of your site, e.g. /blog
url: "" # the base hostname & protocol for your site, e.g. http://example.com
Jekyll-now provides a simpler configuration with fewer options, while Jekyll offers more detailed settings for greater control over the site's behavior and appearance.
:triangular_ruler: Jekyll theme for building a personal site, blog, project documentation, or portfolio.
Pros of Minimal Mistakes
- More feature-rich and customizable theme with extensive documentation
- Regular updates and active community support
- Responsive design with multiple layout options
Cons of Minimal Mistakes
- Steeper learning curve for beginners
- More complex setup process
- Potentially overwhelming for simple blog projects
Code Comparison
Jekyll Now:
# Site settings
title: Your Name
description: Web Developer from Somewhere
avatar: https://raw.githubusercontent.com/barryclark/jekyll-now/master/images/jekyll-logo.png
Minimal Mistakes:
# Site settings
locale: "en-US"
title: "Your Site Title"
subtitle: "A subtitle for your site"
name: "Your Name"
description: "Web Developer from Somewhere"
url: "https://yourdomain.com"
Summary
Minimal Mistakes offers a more robust and feature-rich Jekyll theme compared to Jekyll Now. It provides greater customization options and regular updates but may be more complex for beginners. Jekyll Now, on the other hand, focuses on simplicity and ease of use, making it ideal for those new to Jekyll or looking for a quick setup. The choice between the two depends on the project's requirements and the user's experience level with Jekyll and web development.
The Jekyll Butler. A no frills responsive Jekyll blog theme.
Pros of Poole
- More minimalist and lightweight design, easier to customize
- Includes built-in support for Sass and CoffeeScript
- Better organized file structure for easier maintenance
Cons of Poole
- Less beginner-friendly, requires more Jekyll knowledge
- Fewer pre-built features and layouts out of the box
- Less active community and fewer recent updates
Code Comparison
Jekyll-now _config.yml
:
name: Your Name
description: Web Developer from Somewhere
avatar: https://raw.githubusercontent.com/barryclark/jekyll-now/master/images/jekyll-logo.png
footer-links:
dribbble:
email:
facebook:
flickr:
Poole _config.yml
:
# Setup
title: Poole
tagline: The Jekyll Butler
url: http://getpoole.com
paginate: 1
baseurl: ""
Jekyll-now focuses on social media links and personal information, while Poole's configuration is more centered on site structure and pagination. Poole's approach is more minimalist, allowing for greater customization but requiring more effort to set up initially.
Both repositories serve as starting points for Jekyll-based websites, but cater to different user needs and skill levels. Jekyll-now is more suited for beginners looking for a quick setup, while Poole appeals to developers seeking a cleaner slate for customization.
✨ Build a beautiful and simple website in literally minutes. Demo at https://beautifuljekyll.com
Pros of Beautiful Jekyll
- More feature-rich with built-in support for tags, search functionality, and social media integration
- Highly customizable with numerous configuration options and pre-built color themes
- Responsive design that works well on various devices and screen sizes
Cons of Beautiful Jekyll
- Steeper learning curve due to more complex structure and configuration options
- Requires more setup time compared to the simpler Jekyll Now template
- May be overkill for users seeking a basic, minimalist blog
Code Comparison
Beautiful Jekyll configuration snippet:
title: My Website
author: Your Name
navbar-links:
About Me: "aboutme"
Resources:
- Beautiful Jekyll: "https://beautifuljekyll.com"
- Learn markdown: "https://www.markdowntutorial.com/"
Jekyll Now configuration snippet:
name: Your Name
description: Web Developer from Somewhere
avatar: https://raw.githubusercontent.com/barryclark/jekyll-now/master/images/jekyll-logo.png
footer-links:
dribbble:
email:
facebook:
Both repositories provide Jekyll-based templates for creating personal websites or blogs. Beautiful Jekyll offers more features and customization options, while Jekyll Now focuses on simplicity and ease of use for beginners.
Github Pages template for academic personal websites, forked from mmistakes/minimal-mistakes
Pros of academicpages.github.io
- Tailored for academic portfolios with specific sections for publications, talks, and teaching
- More customizable with additional features like Google Analytics integration
- Includes a data-driven CV page
Cons of academicpages.github.io
- Steeper learning curve due to more complex structure and features
- Requires more setup and configuration compared to the simpler jekyll-now
- May be overwhelming for users who don't need academic-specific features
Code Comparison
jekyll-now:
name: Your Name
description: Web Developer from Somewhere
avatar: https://raw.githubusercontent.com/barryclark/jekyll-now/master/images/jekyll-logo.png
academicpages.github.io:
name: Your Name
bio: "Your biography for the about page"
location: "Location"
employer: "Your Employer"
googlescholar: "http://yourfullgooglescholarurl.com"
orcid: "your ORCID ID"
The code snippets show that academicpages.github.io includes more academic-specific fields in its configuration, while jekyll-now keeps it simpler with basic personal information.
Minimal is a Jekyll theme for GitHub Pages
Pros of minimal
- More lightweight and focused theme, ideal for simple project pages
- Actively maintained with regular updates and improvements
- Better accessibility and responsive design out of the box
Cons of minimal
- Less feature-rich compared to jekyll-now, requiring more customization
- Limited layout options and predefined styles
- Steeper learning curve for beginners due to minimal default content
Code Comparison
minimal:
theme: jekyll-theme-minimal
title: [The title of your site]
description: [A short description of your site's purpose]
jekyll-now:
name: Your Name
description: Web Developer from Somewhere
avatar: https://raw.githubusercontent.com/barryclark/jekyll-now/master/images/jekyll-logo.png
footer-links:
dribbble:
email:
facebook:
flickr:
The minimal theme uses a simpler configuration approach, while jekyll-now provides more detailed customization options in the default configuration.
Convert designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual CopilotREADME
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 :sparkles:update your _config.yml:sparkles: 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 :relaxed:
- 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!
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 https://yourgithubusername.github.io (if it's not, you can often force it to build by completing step 2)
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 https://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:
- Edit files within your new username.github.io repository in the browser at GitHub.com (shown below).
- 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.
- Clone down your repository and make updates locally, then push them to your GitHub repository.
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.
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
- 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. - Clone down your fork
git clone https://github.com/yourusername/yourusername.github.io.git
- Serve the site and watch for markup/sass changes
jekyll serve
- View your website at http://127.0.0.1:4000/
- 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. :metal:
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:
- Hyde by MDO
- Lanyon by MDO
- mojombo.github.io by Tom Preston-Werner
- Left by Zach Holman
- Minimal Mistakes by Michael Rose
- Skinny Bones by Michael Rose
Credits
- Jekyll - Thanks to its creators, contributors and maintainers.
- SVG icons - Thanks, Neil Orange Peel. They're beautiful.
- Solarized Light Pygments - Thanks, Edward.
- Joel Glovier - Great Jekyll articles. I used Joel's feed.xml in this repository.
- David Furnes, Jon Uy, Luke Patton - Thanks for the design/code reviews.
- Bart Kiers, Florian Simon, Henry Stanley, Hun Jae Lee, Javier Cejudo, Peter Etelej, Ben Abbott, Ray Nicholus, Erin Grand, Léo Colombaro, Dean Attali, Clayton Errington, Colton Fitzgerald, Trace Mayer - Thanks for your fantastic contributions to the project!
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. :guardsman:
Top Related Projects
:globe_with_meridians: Jekyll is a blog-aware static site generator in Ruby
:triangular_ruler: Jekyll theme for building a personal site, blog, project documentation, or portfolio.
The Jekyll Butler. A no frills responsive Jekyll blog theme.
✨ Build a beautiful and simple website in literally minutes. Demo at https://beautifuljekyll.com
Github Pages template for academic personal websites, forked from mmistakes/minimal-mistakes
Minimal is a Jekyll theme for GitHub Pages
Convert designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual Copilot