Go to file

Ashwin Maroli 06c49c7af6 Configure cache_dir (#7232 ) Merge pull request 7232		2019-02-15 08:47:00 -05:00
.github	Update Pull Request Template	2019-02-15 14:40:49 +05:30
benchmark	Refactoring: Fix benchmark code smell (#7211 )	2018-09-02 14:01:11 -04:00
docs	Redirect docs/resources	2019-02-14 22:44:36 +01:00
exe	Enforce Style/FrozenStringLiteralComment. (#6265 )	2017-08-03 21:27:32 -04:00
features	Configure cache_dir (#7232 )	2019-02-15 08:47:00 -05:00
lib	Configure cache_dir (#7232 )	2019-02-15 08:47:00 -05:00
rake	Remember to release docs gem (#7066 )	2018-06-17 11:36:54 -04:00
rubocop	Write a Rubocop Cop to ensure no `#p` or `#puts` calls get committed to master. (#6615 )	2018-01-20 17:04:52 -05:00
script	Change regex to sanitize and normalize filenames passed to LiquidRenderer (#6610 )	2018-03-09 21:09:55 -05:00
test	Configure cache_dir (#7232 )	2019-02-15 08:47:00 -05:00
.codeclimate.yml	Upgrade to Code Climate config v2	2018-12-10 18:16:02 +05:30
.editorconfig	Add .editorconfig	2016-09-24 23:21:33 +02:00
.gitignore	update .gitignore	2018-08-16 18:06:56 +02:00
.jrubyrc	Cleanup .jrubyrc	2016-01-10 14:55:35 -06:00
.rubocop.yml	Bump Rubocop to v0.59.0 (#7237 )	2018-09-09 18:14:46 -04:00
.travis.yml	Test with the new Ruby v2.6 (#7438 )	2019-01-02 02:31:36 -05:00
CODE_OF_CONDUCT.markdown	docs: update CoC to 1.4.1	2018-11-19 22:52:24 +01:00
Gemfile	bump Rubocop	2019-02-10 16:43:57 +01:00
History.markdown	Update history to reflect merge of #7497 [ci skip]	2019-02-14 16:32:18 -05:00
LICENSE	Update LICENSE	2019-01-09 20:53:38 +01:00
README.markdown	link site to sponsor listing in readme (#7405 )	2018-12-06 11:53:29 -05:00
Rakefile	enable 'Lint/RescueWithoutErrorClass' Cop (#6482 )	2017-10-28 11:24:41 -04:00
appveyor.yml	Test with Ruby 2.6 on AppVeyor [skip travis] (#7518 )	2019-02-12 03:32:32 -05:00
jekyll.gemspec	dev: update gemspec (#7425 )	2019-02-02 16:03:44 -05:00

README.markdown

Jekyll

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.

See: https://jekyllrb.com/philosophy

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 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
Watch video tutorials from Giraffe Academy

Need help?

If you don't find the answer to your problem in our docs, or in the troubleshooting section, ask the community for help.

Code of Conduct

In order to have a more open and welcoming community, Jekyll adheres to a code of conduct adapted from the Ruby on Rails code of conduct.

Please adhere to this code of conduct in any interactions you have in the Jekyll community. It is strictly enforced on all official Jekyll repositories, websites, and resources. If you encounter someone violating these terms, please let one of our core team members know and we will address it as soon as possible.