NEW Template Features
New Features Included in this latest Master Jekyll Template
Features
- Integrated Lunrjs Search
- Design For Markdown
- Integrated Bootstrap 5.3
- Integrated Bootstrap Icons
- Responsive Design
- Portfolio Ready Design
- Blog Ready (You are reading it now)
- Blog Tag Word Cloud
- Git Build Info For Trouble Shooting
- Top Nav Display Page Option
- Footer Nav Display Option
- Page Header Images
- Header Image Alt Text
- Sidebar Headers For Page Navigation
- Show Page Top Link Option
- Exclude Page From Search Option
- Git Pre-Commit Hooks with Installation Script
- Site Map Generation
- Formspree Contact EMail Form Intergration
- Google Cloud Function Can Handle Contact EMails
- HTMX Integration
Site Level Parameters
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
Template Page Parameters
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
Install Git Hook
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.
Tag Cloud
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.
Search
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.
Sitemap Generation
Automatically generate a sitemap.xml page for the website.