Jekyll

From IndieWeb
Jump to: navigation, search


Jekyll is Ruby software that helps you create "Simple, blog-aware, static sites" suitable for static domain hosting. It is simple in sense that it does one thing well. It compiles HTML and markdown files into a static website.

The learning curve is steep for those not used to HTML. However, there is a pattern of people migrating from WordPress to Jekyll, and many people in IRC have experience with setting up Jekyll.

It was made popular by GitHub's offer to build and host your jekyll powered website for free. While GitHub may be a form of a silo that can easily host a Jekyll website, Jekyll has no dependence upon GitHub. Projects like jekyll-hook can help replicate the publishing workflow that GitHub offers on your own server.

See also: projects#Jekyll

Contents

Pros

  • It's git friendly!
  • It's a great way to learn more about websites HTML, CSS and other web technologies and standards.
  • Open source and free!
  • Large community and active development team
  • Lets you create pretty much any kind of static website you want.
  • Has a powerful plugin system
  • Easily self hosted
  • Simple static pages are the result of your hard work.
  • Free hosting on gh-pages or amazon s3

Cons

  • The liquid templating engine has no love for pretty HTML
  • It takes a while to learn the ins and outs of what can be created.
  • Static pages restricts your options when participating in the real-time web
  • POSSE is tricky with jekyll.
  • Learning to use the ruby toolchain is really difficult for beginners and non-technical people
  • Minimal options for sending webmentions. Webmentions must be sent after site built due to need for URL to exist.

Related Tools

  • Pagoda - a self hosted, mobile friendly editor for jekyll pages.
  • jekyll hook - A self hosted gh-pages like server.
  • Prose.io - An editor for github repositories. Itself is hosted on GH-pages and runs almost entirely client side in the browser. read more
  • gitpub an experimental git based micropub client that works with jekyll.
  • jekmentions - a webmention endpoint specifically designed for Jekyll sites on GitHub pages that commits the received webmentions to a Jekyll collection.
  • A quick, but wrong, fix for blank lines in Jekyll - a hacky script (see bottom of blog post) that strips out extraneous blank lines (unless they are in pre or code blocks) from a built site.
  • Jekyll-IndieWeb - a Jekyll starter install with microformat markup, including support for h-card and receiving webmentions. Work in progress…
  • Micropub-to-GitHub - a self-hosteable Micropub endpoint that accepts Micropub requests, formats them for Jekyll and then commits them to a GitHub repository. Perfect in combination with GitHub Pages.
  • webmention.herokuapp.com - a hosted Webmention endpoint that was built to make it easy to accept Webmentions on a static site like Jekyll.
  • ... Please add more as you find them

IndieWeb Examples

IndieWeb community members using Jekyll on their own primary sites:

Other Notable Examples

Troubleshooting

Something is not working on my local box

Something is not working on my local box.

Be sure to:

  • Update rvm (ruby)
  • install the liquid gem
  • gem install jekyll

gem install jekyll hangs indefinitely

"gem install jekyll" hangs indefinitely

Note:

  • gem install jekyll takes a very long time. It may appear to be hanging but just let it go. Go for a walk or something.

Asks

  • It would be nice to document step by step on example solutions and problems with POSSE-ing a typical Jekyll install.

See Also

Retrieved from "https://indieweb.org/Jekyll"
Personal tools
Namespaces
Variants
Actions
Recent & Upcoming
Resources
Toolbox