Jekyll is a static site generator that’s perfect for GitHub hosted blogs. (Jekyll Repository)
Jekyll Now makes it easier to create Jekyll blogs, by eliminating a lot of the setup. (Jekyll Now Repository)
Build a Jekyll-dribbble portfolio in minutes, without touching the command line!
- 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!
STEP 1: Fork Jekyll Shoot to your User Repository
Fork this repo, then rename the repository to USERNAME.github.io.
Your Jekyll blog will often be viewable immediately at http://USERNAME.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.
Don’t forget to enter a Dribbble
Client Access Token to generate the portfolio (Read more).
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://USERNAME.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
/_posts/2017-3-1-Hello-World.html 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:
- Install Jekyll and plug-ins in one fell swoop.
gem install github-pagesThis 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/username/username.github.io.git
- Serve the site and watch for markup/sass changes
- 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.
Open an Issue and let’s chat!
- Jekyll - Thanks to its creators, contributors and maintainers.
- Jekyll Now - Thank you @barryclark, and all your helpers :)
- Jribbble - Thank you @tylergaw, great work!
- Flexboxgrid-sass - @hugeinc, thanks guys.
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 Shooot 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 💂.