Jekyll Documentation

Main Page

Guides

Sections

1. Enabling Travis and GitHub - Travis CI
1. Follow Your Project on CircleCI - CircleCI
1. Getting started - Buddy
1. Getting started - Razorops
1. Setup - Step by Step Tutorial
1. Use Jekyll - Becoming a Maintainer
10. Deployment - Step by Step Tutorial
2. Dependencies - CircleCI
2. Help Triage Issues - Becoming a Maintainer
2. How it works - Buddy
2. How it works - Razorops
2. Liquid - Step by Step Tutorial
2. The Test Script - Travis CI
21YunBox - 3rd Party
3. Configuring Your Travis Builds - Travis CI
3. Front Matter - Step by Step Tutorial
3. Testing - CircleCI
3. Using YAML for configuration - Buddy
3. Write Documentation - Becoming a Maintainer
4. Layouts - Step by Step Tutorial
4. Setting up on-premises server - Buddy
4. Write Code - Becoming a Maintainer
5. Includes - Step by Step Tutorial
5. Questions? - Buddy
5. Review Pull Requests - Becoming a Maintainer
6. Ask! - Becoming a Maintainer
6. Data Files - Step by Step Tutorial
7. Assets - Step by Step Tutorial
8. Blogging - Step by Step Tutorial
9. Collections - Step by Step Tutorial
AWS Amplify - 3rd Party
Add authors - Step by Step Tutorial
Add content - Collections
Add front matter to static files - Static Files
Adding a screenshot - Themes
Advanced Kramdown Options - Markdown Options
Advantages of using Actions - GitHub Actions
Affinity teams & their captains - Affinity Team Captains
Amazon S3 - Manual Deployment
ArchLinux - Jekyll on Linux
Assets - Themes
Attribution - Code of Conduct
Auto Regeneration - Jekyll on Windows
Base-URL Problems - Troubleshooting
Best Practices - Your first plugin
Binary operators in where_exp filter4.0 - Liquid Filters
Bug? - Triaging an Issue
Build - Step by Step Tutorial
Build Command Options - Configuration Options
Build and deploy - GitHub Actions
Build the About page - Step by Step Tutorial
Build the docs - Releasing a new version
Built-in Hook Owners and Events - Hooks
Built-in formats - Permalinks
Bump the version - Releasing a new version
Bundler - Ruby 101
CI Must Pass - Reviewing a Pull Request
CSV/TSV Parse Options - Data Files
Categories - Posts
Changing the output URL - Pages
Clear Linux - Jekyll on Linux
CloudCannon - 3rd Party
Code Review - Merging a Pull Request
Code snippet highlighting - Tags Filters
Coffeescript - Assets
Collections - Collections
Collections - Permalinks
Commands - Your first plugin
CommonMark - Markdown Options
Complete Example .circleci/config.yml File - CircleCI
Configuration - Step by Step Tutorial
Configuration problems - Troubleshooting
Continuous Integration Service - Automated Deployment
Control over gemset - GitHub Actions
Converters - Your first plugin
Converting gem-based themes to regular themes - Themes
Could not find a JavaScript runtime. (ExecJS::RuntimeUnavailable) - Troubleshooting
Create a site - Step by Step Tutorial
Creating Posts - Posts
Creating a gem-based theme - Themes
Creating a layout - Step by Step Tutorial
Current page highlighting - Step by Step Tutorial
Custom Markdown Processors - Markdown Options
Custom Sorting of Documents4.0 - Collections
Custom Variables - Front Matter
Data file usage - Step by Step Tutorial
Debian - Jekyll on Linux
Debian or Ubuntu - Troubleshooting
Defaults - WEBrick Options
Deploying Jekyll to GitHub Pages - GitHub Pages
Deployment - Step by Step Tutorial
Detecting nil values with where filter4.0 - Liquid Filters
Displaying an index of posts - Posts
Documenting your theme - Themes
Documents - Collections
Drafts - Posts
Enable pagination - Pagination
Encoding - Jekyll on Windows
Enforcement - Code of Conduct
Environments - Step by Step Tutorial
Example: Accessing a specific author - Data Files
Example: List of members - Data Files
Excerpts - Troubleshooting
Excerpts for pages4.1.1 - Pages
External links - GitHub Actions
FTP - Manual Deployment
Feature? - Triaging an Issue
Fedora - Jekyll on Linux
Filters - Step by Step Tutorial
Filters - Your first plugin
Flags - Your first plugin
For non-core gems - Releasing a new version
Front Matter - Permalinks
Front matter defaults - Step by Step Tutorial
Gemfile - Ruby 101
Gemfile - Step by Step Tutorial
Gems - Ruby 101
Generators - Your first plugin
Gentoo - Jekyll on Linux
Getting Help - Support
Git post-receive hook - Automated Deployment
GitHub Pages - 3rd Party
GitLab Pages - 3rd Party
Glob patterns in Front Matter defaults - Front Matter Defaults
Global - Permalinks
Global Configuration - Configuration Options
Global Variables - Variables
Guides - Installation
HTML Proofer - CircleCI
Hooks - Your first plugin
Hooks for custom Jekyll objects - Hooks
Hostman - 3rd Party
How do I become a team captain? - Affinity Team Captains
Include tag - Step by Step Tutorial
Include usage - Step by Step Tutorial
Includes - Tags Filters
Including files relative to another file - Includes
Including images and resources - Posts
Incremental Regeneration - Default Configuration
Inheritance - Layouts
Install Jekyll - Jekyll on Linux
Install Jekyll - Jekyll on macOS
Install Jekyll Gems - Jekyll on FreeBSD
Install Ruby - Jekyll on FreeBSD
Install Ruby - Jekyll on macOS
Install Ruby Gems - Jekyll on FreeBSD
Install dependencies - Jekyll on Ubuntu
Install prerequisites - Jekyll on Linux
Installation - Step by Step Tutorial
Installation Problems - Troubleshooting
Installation via Bash on Windows 10 - Jekyll on Windows
Installation via RubyInstaller - Jekyll on Windows
Installing Ruby and Jekyll - Jekyll on Windows
Installing a gem-based theme - Themes
Jekyll & macOS - Troubleshooting
Jekyll Contributor Code of Conduct - Community
Jekyll Variables - Variables
Jekyll on Twitter - Community
Jekyllconf - Community
KeyCDN - 3rd Party
Kickster - 3rd Party
Kinsta Application Hosting - 3rd Party
Kramdown - Markdown Options
Kramdown Processor - Markdown Options
Layer0 - 3rd Party
Layout - Step by Step Tutorial
Layouts and includes - Themes
Line numbers - Tags Filters
Link to authors page - Step by Step Tutorial
Linking to pages - Tags Filters
Linking to posts - Tags Filters
Links - Tags Filters
Liquid - Troubleshooting
Liquid Attributes - Collections
Liquid Attributes Available - Pagination
List author’s posts - Step by Step Tutorial
List posts - Step by Step Tutorial
Look for Tests - Reviewing a Pull Request
Manually Ordering Documents - Collections
Marking specific lines4.4.0 - Tags Filters
Markup Problems - Troubleshooting
Merging - Merging a Pull Request
Minor updates - Upgrading
More posts - Step by Step Tutorial
Netlify - 3rd Party
Objects - Step by Step Tutorial
OpenSUSE - Jekyll on Linux
Options for the slugify filter - Liquid Filters
Our Pledge - Code of Conduct
Our Responsibilities - Code of Conduct
Our Standards - Code of Conduct
Output - Collections
Output a page - Step by Step Tutorial
Overriding theme defaults - Themes
Page Variables - Variables
Pages - Permalinks
Paginator - Variables
Passing parameter variables to includes - Includes
Passing parameters to includes - Includes
Permalinks - Collections
Pick up a theme - Themes
Placeholders - Permalinks
Plugins - Step by Step Tutorial
Post excerpts - Posts
Posts - Step by Step Tutorial
Pre-configuring Theme-gems4.0 - Themes
Precedence - Front Matter Defaults
Predefined Global Variables - Front Matter
Predefined Variables for Posts - Front Matter
Previewing your theme - Themes
Problems running Jekyll - Troubleshooting
Production Problems - Troubleshooting
Project Page URL Structure - GitHub Pages
Project Pages - GitHub Pages
Publish GitHub Release - Releasing off older stable branches
Publish release post - Releasing off older stable branches
Publishing your theme - Themes
Push the version - Releasing a new version
Questions? - CircleCI
Questions? - Travis CI
RHEL8/CentOS8 - Jekyll on Linux
Rack-Jekyll - Manual Deployment
Rejoice - Merging a Pull Request
Render - 3rd Party
Render the paginated Posts - Pagination
Report a bug - Support
Reporting Security Vulnerabilities - Community
Reporting a Vulnerability - Security Policy
Reproducibility - Triaging an Issue
Requirements - Installation
Requirements - Releasing off older stable branches
Resolve Quickly - Reviewing a Pull Request
Respond Kindly - Reviewing a Pull Request
Respond Quickly - Reviewing a Pull Request
Responsibilities of Team Captains - Affinity Team Captains
Rule of Two - Reviewing a Pull Request
Running Jekyll as Non-Superuser (no sudo!) - Troubleshooting
Running and Testing Locally - GitHub Pages
Sass - Step by Step Tutorial
Sass/SCSS - Assets
Scope - Code of Conduct
Serve Command Options - Configuration Options
Set Gems directory and add that to the Bash path - Jekyll on FreeBSD
Setting up the Action - GitHub Actions
Setup - Collections
Site Variables - Variables
Sort By Front Matter Key - Collections
Staff page - Step by Step Tutorial
Staleness and automatic closure - Triaging an Issue
Standard Liquid Filters - Liquid Filters
Static Publisher - 3rd Party
Step 1: Install Homebrew - Jekyll on macOS
Step 2: Install chruby and the latest Ruby with ruby-install - Jekyll on macOS
Stylesheets - Themes
Stylesheets for syntax highlighting - Tags Filters
Subfolders - Data Files
Supported Platform - Triaging an Issue
Supported Versions - Security Policy
Supported macOS versions - Jekyll on macOS
Syntax Highlighting (CodeRay) - Markdown Options
Tag Blocks - Tags
Tags - Posts
Tags - Step by Step Tutorial
Tags - Your first plugin
Tags and Categories - Posts
Technical Aspects - Generators
The :jekyll_plugins Gemfile group - Plugins
The Data Folder - Data Files
The HTML Proofer Executable - Travis CI
The HTML Proofer Library - Travis CI
The Posts Folder - Posts
Theme Variables4.3.0 - Variables
Theme-gem dependencies3.5.0 - Themes
Themes with _data directory4.3.0 - Themes
Think Security - Reviewing a Pull Request
Time Zone Management - Jekyll on Windows
Trigger release workflow - Releasing off older stable branches
Troubleshooting - Jekyll on macOS
Troubleshooting - Travis CI
Ugh, I’m tired and don’t have time to be a captain anymore. What now? - Affinity Team Captains
Understanding gem-based themes - Themes
Update default branch to reflect release off the stable branch - Releasing off older stable branches
Update the History document - Releasing a new version
Usage - Layouts
Use Liquid - Step by Step Tutorial
Use front matter - Step by Step Tutorial
Use layouts - Step by Step Tutorial
User and Organization Pages - GitHub Pages
Using a Gemfile - Plugins
Using variables names for the include file - Includes
Variables - Layouts
Vercel - 3rd Party
Verify install - Jekyll on FreeBSD
Ways to contribute - Community
What they wanted vs. what they got - Triaging an Issue
Where to get support - Community
Workflow Management - GitHub Actions
Workspace setup - GitHub Actions
Wrap up - Step by Step Tutorial
Write a release post - Releasing a new version
macOS - Troubleshooting
needs-work & pending-rebase - Special Labels
pending-feedback - Special Labels
pinned - Special Labels
rsync - Manual Deployment
scp - Manual Deployment
stale - Special Labels