Go to file

jekyllbot 6d2d29220c Update history to reflect merge of #9511 [ci skip]		2023-12-27 12:52:14 -08:00
.devcontainer	Fix typo in devcontainer.json (#9364 )	2023-08-13 17:32:28 -07:00
.github	Configure dependabot to handle rubygems dependencies (#9445 )	2023-10-31 08:59:12 -07:00
benchmark	Optimize `Jekyll::Utils.parse_date` (#8425 )	2021-07-22 13:43:47 -04:00
docs	Add release post for v4.3.3 (#9511 )	2023-12-27 12:52:12 -08:00
exe	Enforce Style/FrozenStringLiteralComment. (#6265 )	2017-08-03 21:27:32 -04:00
features	Rename sass partial created for new blank site (#9257 )	2023-01-18 23:00:21 -08:00
lib	Add release post for v4.3.3 (#9511 )	2023-12-27 12:52:12 -08:00
rake	Manage repository meta documents consistently (#8908 )	2021-12-17 10:14:19 -05:00
rubocop	Scan `assert_equal` methods and rectify any offenses with a custom Rubocop cop (#7130 )	2019-03-15 15:12:09 -04:00
script	script/default-site: accept flags for `jekyll new` (#9259 )	2023-01-18 23:05:39 -08:00
test	Test suite uses shoulda-context only. (#9441 )	2023-09-15 08:47:57 -07: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
.gitattributes	Ci/GitHub actions (#7822 )	2019-09-26 13:32:59 -04:00
.gitignore	Gitignore all folder names with `-cache` [skip ci]	2019-09-15 12:43:35 +05:30
.jrubyrc	Cleanup .jrubyrc	2016-01-10 14:55:35 -06:00
.rubocop.yml	Bump Rubocop to version 1.48.x (#9326 )	2023-03-26 02:05:10 -07:00
.rubocop_todo.yml	Stop testing with Rubies older than 2.7 on non-Windows (#8955 )	2022-04-07 01:56:42 -07:00
Earthfile	Cross Version Testing Locally and Faster CI (#8610 )	2021-03-25 20:47:13 -04:00
Gemfile	Update rubocop gem (#9476 )	2023-10-31 09:47:18 -07:00
History.markdown	Update history to reflect merge of #9511 [ci skip]	2023-12-27 12:52:14 -08:00
LICENSE	Update LICENSE	2019-01-09 20:53:38 +01:00
README.markdown	Improve links (http -> https) (#9064 )	2022-06-20 20:35:42 -07:00
Rakefile	Fix IRB error "ubygems" (#8199 ) (#8312 )	2020-07-23 03:03:48 -04:00
appveyor.yml	Clean up AppVeyor config	2023-01-27 20:05:37 +05:30
jekyll.gemspec	Support jekyll-sass-converter 3.x (#9132 )	2022-10-16 07:37:05 -07: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 and #jekyll Channel on Libera IRC

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.