Skip to content

Instantly share code, notes, and snippets.

@leatheresque
Last active April 24, 2023 13:39
Show Gist options
  • Save leatheresque/07bc464eccfd2bae98f959fa55354086 to your computer and use it in GitHub Desktop.
Save leatheresque/07bc464eccfd2bae98f959fa55354086 to your computer and use it in GitHub Desktop.
Example config file with more configuration settings that can be used with Jekyll.
repository : jekyllgems/base
github : [metadata]
# This is a base template for Jekyll. The starter template that
# ships with "jekyll new sitename" is complete trash.
#
# It is not good for a person coming to Jekyll with no knowledge
# of programming or themeing as is the general purpose of the Jekyll
# framework according to their own statments.
#
# If you need any help feel free to reach out on discord or email
# me and I will help in any way you need. If you want a custom theme
# or plugin built you can hop on discord and we can discuss it.
#
# =============
# SOCIAL LINKS
# =============
#
# This section handles your social network links displayed across
# your site in liquid tags as site.social.NAME feel free to reach
# out to me using these if you need any help.
social:
github : leatheresque
email : jekyllcoder@gmail.com
discord : leatheresque#3820
support_server : https://discord.gg/8uc5FyPdHk
# ==========
# SITE TITLE
# ==========
#
# This is the title of your website for example, "The Moo York Times" :)
title: Your New Site
description: >- # this means to ignore newlines until "baseurl:"
Welcome to your new site, replace this description
# =======
# BASEURL
# =======
#
# This is the subpath of your site, e.g. /blog if you want users to
# access your site at https://example.com/blog
#
# If you are using a gh-pages site this will be empty if your site
# is on https://username.github.io if your repo using this theme is
# named "foobar" then change this to /foobar and when you serve
# it using the pages setting it will be live at
#
# https://username.github.io/foobar
baseurl : "/base"
# ===
# URL
# ===
#
# This is the base hostname & protocol for your site, as you see
# I use https://jekyllgems.github.io because this is a template
# and served live on my gh-pages site.
#
# Use localhost for local development
# http://localhost:4000
url : "https://jekyllgems.github.io"
# =================
# EXCERPT_SEPARATOR
# =================
#
# This is used in your blog posts, you can see an example in any
# of the example blog posts included in this theme. It functions
# to trim your posts when displaying them so it doesnt show the
# entire post like on the front page. Feel free to change where
# the excerpt ends.
excerpt_separator: <!--more-->
# ==============
# BUILD SETTINGS
# ==============
#
# These are build settings needed for when you run "jekyll serve"
# commands. You can change these, but be careful because they can
# cause your site to break.
#
# COLLECTIONS
# ===========
#
# Collections are Jekylls way to handle things like tags, categories,
# authors. Any type of data you can iterate over. Here is how you add
# categories to your blog. Uncomment this to have it assign links for
# your categories
#
# collections:
# categories: # This will create your category links
# output: true
# permalink: /:categories/:title/
#
# =======
# PLUGINS
# =======
#
# This is just one of the plugins you can use with jekyll
# you can find more useful plugins I have created at:
#
# https://github.com/jekyllgems/plugins
plugins:
- jekyll-feed
title: Your Site Title
description: >- # this means to ignore newlines until "baseurl:"
This is the personal website of leatheresque where you can find gems created by him.
baseurl : ""
url : "http://localhost:4000"
social:
github : leatheresque
linkedin : jekyllcoder
dev_to : leatheresque
email : jekyllcoder@gmail.com
discord_id : leatheresque#3820
invite_link : 8uc5FyPdHk
plugins:
- jekyll-feed
collections:
categories:
output: true
permalink: /:categories/:title/
# Site settings
title: Your Site Title
description: A brief description of your site
baseurl: "" # The subpath of your site, e.g. /blog/
url: "https://example.com" # The base hostname & protocol for your site
timezone: America/New_York
# Build settings
markdown: kramdown
theme: minima
plugins:
- jekyll-feed
# Permalinks
permalink: /:categories/:year/:month/:day/:title.html
# Pagination
paginate: 10
paginate_path: "/page:num/"
# Collections
collections:
blog:
output: true
permalink: /blog/:categories/:year/:month/:day/:title.html
excerpt_separator: <!--more-->
tag_page_layout: tag_page
# Defaults for each post
defaults:
-
scope:
path: "" # empty string for all files in the repo
type: "posts"
values:
layout: "post"
comments: true
# Navigation
header_pages:
- about.md
- contact.md
# Exclude files & directories
exclude:
- Gemfile
- Gemfile.lock
- vendor
- _site
- node_modules
- .sass-cache
# Redirects
redirects:
"/old-page.html": "/new-page/"
# Markdown options
kramdown:
input: GFM
hard_wrap: false
syntax_highlighter: rouge
syntax_highlighter_opts:
css_class: "highlight"
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment