Site Wide Parameters in the _config.yml file.
search_enabled: true or false # Turn on or off the search form
git_build_data_color: '#eee' # Color of the build data in the footer
google_analytics: true or false # Turn on/off Google Analytics
google_tag_manager: 'GTM-XXXXXXX' # Your Google Tag Manager Id
sidebar_headers: true or false # Site Wide Sidebar Headers
show_top_link: true or false # Show The 'Back To Top' Link in Sidebar
formspree_id: 'your_formspree_id' # Contact Page Formspree Id
htmx_enabled: true or false # Turn on/off HTML Sitewide
Page-Level frontmatter Parameters:
layout: home,default,page,post, or tags # Layout of the page
title: The Page Title # Title of the page
nav_display: true or false # Show this page in the navigation?
footer_nav_display: true or false # Shows the page in the footer even if its not in the top nav
image: "/path or https://url.png" # Path To Your Page Header Image
image_alt: "Alt text for the image" # Image Alt Text
header_title: "Header Title" # Display header text
exclude_search: true # Exclude this page from search results?
sidebar_headers: true or false # Display the sidebar headers on this page
show_top_link: true or false # Display the 'Back To Top' link in the sidebar header
permalink: /path/to/page/ # Same as jekyll's permalink
htmx_enabled: true or false # Turn on/off HTML For a Single Page
Like to Code Your own Site? Use the install script to Setup Git Your Pre-Commit Hook.
$ install_git_hooks.sh
This script will install a script that automagically intiates blog tag pages building and GitHub site build information. For easy tracking of your current running build.
The tag cloud is generated from the keyword tags in your _posts files. Note: Tags all should be lowercased!!!
Example FrontMatter:
tags: [jekyll, welcome, test]
Tag pages will be automagically genrated when the git pre-commit hook is run.
You can manually run the following command to generate the tag cloud files
$ ./_posts_tags/_gen_posts_tags_files.sh
You can see the tags that will be generated in the _site_tags_missing.txt file.
Enabled in the _config.yml file with the search_enabled: true parameter.
Search is powered by the Lunr.js library. The index is generated autmatically in the /assets/js/documents.js file.
Automatically generate a sitemap.xml page for the website.
]]>_posts directory. Go ahead and edit it and re-build the site to see your changes. You can rebuild the site in many different ways, but the most common way is to run jekyll serve, which launches a web server and auto-regenerates your site when a file is updated.
Jekyll requires blog post files to be named according to the following format:
YEAR-MONTH-DAY-title.MARKUP
Where YEAR is a four-digit number, MONTH and DAY are both two-digit numbers, and MARKUP is the file extension representing the format used in the file. After that, include the necessary front matter. Take a look at the source for this post to get an idea about how it works.
Jekyll also offers powerful support for code snippets:
def print_hi(name)
puts "Hi, #{name}"
end
print_hi('Tom')
#=> prints 'Hi, Tom' to STDOUT.Check out the Jekyll docs for more info on how to get the most out of Jekyll. File all bugs/feature requests at Jekyll’s GitHub repo. If you have questions, you can ask them on Jekyll Talk.
]]>