Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
###########################################################
Welcome to Beautiful Jekyll!
This config file is meant for settings that affect your entire website. When you first
set up your website you should go through all these settings and edit them, but after
the initial set up you won't need to come back to this file often.
###########################################################
############################
--- Required options ---
############################
Name of website
title: My website
Your name to show in the footer
author: Some Person
###############################################
--- List of links in the navigation bar ---
###############################################
navbar-links:
About Me: "aboutme"
Resources:
- Beautiful Jekyll: "https://beautifuljekyll.com"
- Learn markdown: "https://www.markdowntutorial.com/"
Author's home: "https://deanattali.com"
################
--- Logo ---
################
Image to show in the navigation bar - works best with a square image
Remove this parameter if you don't want an image in the navbar
avatar: "/assets/img/avatar-icon.png"
By default, the image is cut into a circle. You can disable this behaviour by setting 'round-avatar: false'
round-avatar: true
If you want to have an image logo in the top-left corner instead of having the title of the website,
then specify the following parameter
#title-img: /path/to/image
#####################################
--- Footer social media links ---
#####################################
Select the social network links that you want to show in the footer.
You can change the order that they show up on the page by changing the order here.
Uncomment the links you want to show and add your information to each one.
social-network-links:
email: "someone@example.com"
rss: true # remove this line if you don't want to show an RSS link at the bottom
facebook: deanattali
github: daattali
twitter: daattali
patreon: DeanAttali
youtube: "@daattali"
whatsapp: 15551212
medium: yourname
reddit: yourname or r/yoursubreddit
linkedin: daattali
xing: yourname
stackoverflow: "3943160/daattali"
snapchat: deanat78
instagram: deanat78
spotify: yourname
telephone: +14159998888
steam: deanat78
twitch: yourname
yelp: yourname
telegram: yourname
calendly: yourname
mastodon: instance.url/@username
bluesky: yourname
ORCID: your ORCID ID
google-scholar: your google scholar
discord: "invite_code" or "users/userid" or "invite/invite_code"
kaggle: yourname
hackerrank: yourname
gitlab: yourname
itchio: yourname
untappd: yourname
If you want your website to generate an RSS feed, provide a description
The URL for the feed will be https://<your_website>/feed.xml
rss-description: This website is a virtual proof that I'm awesome
###########################
--- General options ---
###########################
Select which social network share links to show in posts
share-links-active:
twitter: true
facebook: true
linkedin: true
vk: false
How to display the link to your website in the footer
Remove this if you don't want a link in the footer
url-pretty: "MyWebsite.com"
Add the website title to the title of every page
title-on-all-pages: true
Excerpt word length - Truncate the excerpt of each post on the feed page to the specified number of words
excerpt_length: 50
Whether or not to show an excerpt for every blog post in the feed page
feed_show_excerpt: true
Whether or not to show a list of tags below each post preview in the feed page
feed_show_tags: true
Add a search button to the navbar
post_search: true
Add a button in the footer to edit the current page. Only works if your website is hosted on GitHub
edit_page_button: true
Allow sub-menu items (second-level navigation menu items) to be longer than the top-level menu
If this setting is off, then long sub-menu words might get cut off
See daattali/beautiful-jekyll#765 to understand the issue this setting can solve
navbar-var-length: false
The keywords to associate with your website, for SEO purposes
#keywords: "my,list,of,keywords"
######################################
--- Colours / background image ---
######################################
Personalize the colours in your website. Colour values can be any valid CSS colour
page-col: "#FFFFFF"
text-col: "#404040"
link-col: "#008AFF"
hover-col: "#0085A1"
navbar-col: "#EAEAEA"
navbar-text-col: "#404040"
navbar-border-col: "#DDDDDD"
footer-col: "#EAEAEA"
footer-text-col: "#777777"
footer-link-col: "#404040"
footer-hover-col: "#0085A1"
Alternatively, the navbar, footer, and page background can be set to an image
instead of colour
#navbar-img: "/assets/img/bgimage.png"
#footer-img: "/assets/img/bgimage.png"
#page-img: "/assets/img/bgimage.png"
Suggest a colour for mobile browsers to use as the browser's theme. This is only supported by a few mobile browsers.
#mobile-theme-col: "#0085A1"
For any extra visual customization, you can include additional CSS files in every page on your site. List any custom CSS files here
#site-css:
- "/assets/css/custom-styles.css"
If you have common JavaScript files that should be included in every page, list them here
#site-js:
- "/assets/js/custom-script.js"
#################################
--- Web Analytics Section ---
#################################
Fill in your Google Analytics tag ID (or "Measurement ID") to track your website usage
#gtag: "G-XXXXXXXXXX"
Fill in your Cloudflare Analytics beacon token to track your website using Cloudflare Analytics
#cloudflare_analytics: ""
Google Tag Manager ID
#gtm: ""
Matomo (aka Piwik) Web statistics
Uncomment the following section to enable Matomo. The opt-out parameter controls
whether or not you want to allow users to opt out of tracking.
#matomo:
site_id: "9"
uri: "demo.wiki.pro"
opt-out: true
Google Universal Analytics ID -- deprecated
As of July 2023 this is no longer supported by Google! If you are still using
google_analytics
,you should switch to using the
gtag
field above instead.#google_analytics: "UA-XXXXXXXX-X"
####################
--- Comments ---
####################
To use Disqus comments, sign up to https://disqus.com and fill in your Disqus shortname (NOT the userid)
#disqus: ""
To use Facebook Comments, create a Facebook app and fill in the Facebook App ID
#fb_comment_id: ""
To use CommentBox, sign up for a Project ID on https://commentbox.io
#commentbox: "" # Project ID, e.g. "5694267682979840-proj"
To use Utterances comments: (0) uncomment the following section, (1) fill in
"repository" (make sure the repository is public), (2) Enable Issues in your repository,
(3) Install the Utterances app in your repository https://github.com/apps/utterances
See more details about the parameters below at https://utteranc.es/
#utterances:
repository: # GitHub username/repository eg. "daattali/beautiful-jekyll"
issue-term: title # Mapping between blog posts and GitHub issues
theme: github-light # Utterances theme
label: blog-comments # Label that will be assigned to GitHub Issues created by Utterances
To use Staticman comments, uncomment the following section. You may leave the reCaptcha
section commented if you aren't using reCaptcha for spam protection.
Using Staticman requires advanced knowledge, please consult
https://github.com/eduardoboucas/staticman/ and https://staticman.net/ for further
instructions. For any support with staticman please direct questions to staticman and
not to BeautifulJekyll.
#staticman:
repository : # GitHub username/repository eg. "daattali/beautiful-jekyll"
branch : master # If you're not using
master
branch, then you also need to update thebranch
parameter instaticman.yml
endpoint : # URL of your deployment, with a trailing slash eg. "https:///v3/entry/github/"
reCaptcha: # (optional, set these parameters in
staticman.yml
as well)siteKey : # You need to apply for a site key on Google
secret : # Encrypt your password by going to https:///v3/encrypt/
To use giscus comments:
(0) Uncomment the following giscus section, (1) Enable Discussions in your GitHub repository,
(2) Install the giscus app in your repository (details at https://giscus.app),
(3) Fill in all the parameters below
See more details about giscus and each of the following parameters at https://giscus.app
#giscus:
hostname: giscus.app # Replace with your giscus instance's hostname if self-hosting
repository: # GitHub username/repository eg. "daattali/beautiful-jekyll"
repository-id: # ID of your repository, retrieve this info from https://giscus.app
category: Announcements # Category name of your GitHub Discussion posts
category-id: # ID of your category, retrieve this info from https://giscus.app
mapping: pathname
reactions-enabled: 1
emit-metadata: 0
theme: light
################
--- Misc ---
################
Ruby Date Format to show dates of posts
date_format: "%B %-d, %Y"
Facebook App ID
#fb_app_id: ""
#################################################################################
--- You don't need to touch anything below here (but you can if you want) ---
#################################################################################
Output options (more information on Jekyll's site)
timezone: "America/Toronto"
markdown: kramdown
highlighter: rouge
permalink: /:year-:month-:day-:title/
paginate: 5
kramdown:
input: GFM
Default YAML values (more information on Jekyll's site)
defaults:
path: "" # any file that's not a post will be a "page" layout by default
values:
layout: "page"
Exclude these files from production site
exclude:
plugins:
Beautiful Jekyll / Dean Attali
2fc73a3a967e97599c9763d05e564189