A week ago, I asked @parkr via email if he could add my site here (mostly because I thought it's too cheeky to just propose a file-change). But now he told me that it's better to just do it here: I'm asking because I spend a huge amount of time and effort on making it great and usefully structured for people who're just getting started with Jekyll. Therefore it's also great as a forked starting-point, if you ask me. Besides keeping the code clean, I also spend much time on making the site as fast as possible. There's not much CSS in use, the HTML output is minified and images are directly served from the repo (and therefore GitHub's CDN) instead of from third-party services. There's also a lot of "include"-thinking happening for things like embedded Tweets, images or iFrames - which most people just inline in each post. When making a significant change, I also always make sure to write a few paragraphs about why I exactly did it as a commit message. And when it comes to really big updates, I write entire posts too (explaining all improvements and their benefits to the site's performance/look). Here's an recent example: http://leo.github.io/notes/v2/ I'm definitely sure that many people could get something out of it. Don't you think so too? |
||
---|---|---|
benchmark | ||
bin | ||
features | ||
lib | ||
script | ||
site | ||
test | ||
.gitignore | ||
.jrubyrc | ||
.travis.yml | ||
CONTRIBUTING.markdown | ||
Gemfile | ||
History.markdown | ||
LICENSE | ||
README.markdown | ||
Rakefile | ||
jekyll.gemspec |
README.markdown
Jekyll
By Tom Preston-Werner, Nick Quaranto, Parker Moore, and many awesome contributors!
Jekyll is a simple, blog-aware, static site generator perfect for personal, project, or organization sites. Think of it like a file-based CMS, without all the complexity. Jekyll takes your content, renders Markdown and Liquid templates, and spits out a complete, static website ready to be served by Apache, Nginx or another web server. Jekyll is the engine behind GitHub Pages, which you can use to host sites right from your GitHub repositories.
Philosophy
Jekyll does what you tell it to do — no more, no less. It doesn't try to outsmart users by making bold assumptions, nor does it burden them with needless complexity and configuration. Put simply, Jekyll gets out of your way and allows you to concentrate on what truly matters: your content.
Getting Started
- Install the gem
- Read up about its Usage and Configuration
- Take a gander at some existing Sites
- Fork and Contribute your own modifications
- Have questions? Check out our official forum community Jekyll Talk or
#jekyll
on irc.freenode.net
Diving In
- Migrate from your previous system
- Learn how the YAML Front Matter works
- Put information on your site with Variables
- Customize the Permalinks your posts are generated with
- Use the built-in Liquid Extensions to make your life easier
- Use custom Plugins to generate content specific to your site
License
See LICENSE.