add instructions

This commit is contained in:
rzen 2019-07-22 23:17:30 -04:00
parent 7f1c2cef97
commit c7c7ee310b

View File

@ -1,31 +1,64 @@
# title of this site # title of this site
title: SAMPLE BLOG # TODO:
title: LONG FORM BLOG
# subtitle # subtitle
# TODO: # TODO:
subtitle: Sample Subtitle subtitle: Sample Subtitle
# site description # site description
# TODO:
description: Sample description description: Sample description
# used on the home page's title tag # used on the home page's title tag
# TODO:
tagline: Sample tagline tagline: Sample tagline
# if specified url to this website will be computed as
# https://blog.example.com/valueofbaseurl/
# TODO:
baseurl: "" baseurl: ""
url: "https://rzen.dev" url: "https://blog.example.com"
# used in footer # used in footer
# TODO
copyright_owner: copyright_owner:
full_name: Your Name full_name: Your Name
short_name: your_short_name short_name: your_short_name
email: youremail@example.com email: youremail@example.com
# default author's name # default author's name
# used in posts, pages and blogs
# TODO
author: author:
short_name: your_short_name short_name: your_short_name
full_name: Your Full Name full_name: Your Full Name
email: youremail at example dot com email: youremail at example dot com
# used in footer of every post, page and blog
# TODO: optional
license:
name: MIT
url: https://opensource.org/licenses/MIT
# timezone
tz: America/New York
# used for edit link in the footer
# leave blank to disable edit link
# TODO: optional
# edit_url: https://github.com/path_to_repo/_edit/master/
# google analytics
# TODO:
# google_analytics_token: 'UA-00000000-1' # leave blank if you don't want google analytics
#
# disqus_short_name: 'your_short_name' # leave blank if you don't want disqus
# advanced
collections: collections:
blog: blog:
permalink: /:collection/:title/ permalink: /:collection/:title/
@ -68,6 +101,8 @@ plugins:
tag_page_layout: tags tag_page_layout: tags
tag_page_dir: tags tag_page_dir: tags
# a superset flavor of Markdown
# https://kramdown.gettalong.org
kramdown: kramdown:
auto_ids: false auto_ids: false
syntax_highlighter_opts: syntax_highlighter_opts:
@ -77,22 +112,17 @@ kramdown:
span: span:
line_numbers: false line_numbers: false
# generated html will be "compressed" by removing
# semantically superfluous whitespace
jekyll_tidy: jekyll_tidy:
compress_html: true compress_html: true
# sass
sass: sass:
sass_dir: _sass sass_dir: _sass
style: compressed style: compressed
include: ["_pages"] # include: ["_pages", "_blog", ]
# dont move the following to _site/ # dont move the following to _site/
exclude: ["docker-compose.yaml", "Gemfile.lock", "Gemfile"] exclude: ["docker-compose.yaml", "Gemfile.lock", "Gemfile"]
tz: America/New York
# used for edit link in the footer
edit_url: https://github.com/path_to_repo/_edit/master/
# google_analytics_token: 'UA-00000000-1' # leave blank if you don't want google analytics
# disqus_short_name: 'your_short_name' # leave blank if you don't want disqus