This enables files such as images and PDFs to show up in the same relative output directory as other HTML and Markdown documents in the same collection. It also enables static files to be hidden using defaults from _config.yml in the same way that other documents in the same collection and directories may be hidden using `published: false`. |
||
---|---|---|
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.