From 489b8963c7c0bafb281ce90335de56c987b95dd6 Mon Sep 17 00:00:00 2001 From: bryan Date: Tue, 14 Jul 2020 17:44:11 -0400 Subject: [PATCH] Merge upstream --- .../.github/issue_template.md | 4 +- .../.github/workflows/ci.yml | 15 + blog.bryanroessler.com/.gitignore | 4 + blog.bryanroessler.com/404.html | 2 +- blog.bryanroessler.com/CHANGELOG.md | 63 +- blog.bryanroessler.com/Gemfile | 8 +- blog.bryanroessler.com/LICENSE | 13 +- blog.bryanroessler.com/README.md | 324 +- blog.bryanroessler.com/_config.yml | 220 +- .../_data/SocialNetworks.yml | 92 - .../_includes/comments.html | 6 + blog.bryanroessler.com/_includes/disqus.html | 24 +- blog.bryanroessler.com/_includes/ext-css.html | 4 +- .../_includes/fb-comment.html | 22 +- .../_includes/footer-minimal.html | 20 +- .../_includes/footer-scripts.html | 4 +- blog.bryanroessler.com/_includes/footer.html | 51 +- .../_includes/google_analytics.html | 16 +- blog.bryanroessler.com/_includes/gtag.html | 5 +- .../_includes/gtm_body.html | 7 +- .../_includes/gtm_head.html | 16 +- blog.bryanroessler.com/_includes/head.html | 110 +- blog.bryanroessler.com/_includes/header.html | 86 +- .../_includes/just_comments.html | 4 - blog.bryanroessler.com/_includes/nav.html | 79 +- .../_includes/readtime.html | 16 + .../_includes/social-networks-links.html | 267 + .../_includes/social-share.html | 17 +- .../_includes/staticman-comments.html | 20 +- .../_includes/utterances-comment.html | 13 + blog.bryanroessler.com/_layouts/base.html | 29 +- blog.bryanroessler.com/_layouts/default.html | 2 +- blog.bryanroessler.com/_layouts/home.html | 88 + blog.bryanroessler.com/_layouts/minimal.html | 20 +- blog.bryanroessler.com/_layouts/page.html | 17 +- blog.bryanroessler.com/_layouts/post.html | 28 +- blog.bryanroessler.com/aboutme.md | 2 +- .../{ => assets}/css/bootstrap-social.css | 0 .../{ => assets}/css/main-minimal.css | 4 +- .../{ => assets}/css/main.css | 622 +- .../{ => assets}/css/pygment_highlights.css | 0 .../{ => assets}/css/staticman.css | 4 +- .../{ => assets}/img/404-southpark.jpg | Bin .../{ => assets}/img/avatar-icon.png | Bin .../{ => assets}/img/bgimage.png | Bin .../{ => assets}/img/hello_world.jpeg | Bin .../{ => assets}/img/install-steps.gif | Bin .../{ => assets}/img/me_square_bw_small.jpg | Bin .../img/me_square_sepia_small.jpg | Bin .../{ => assets}/img/path.jpg | Bin blog.bryanroessler.com/assets/img/thumb.png | Bin 0 -> 396424 bytes .../assets/js/jquery-3.4.1.min.js | 2 + blog.bryanroessler.com/assets/js/main.js | 99 + .../{ => assets}/js/staticman.js | 26 +- .../beautiful-jekyll-theme.gemspec | 26 + .../css/bootstrap-theme.css | 476 -- .../css/bootstrap-theme.css.map | 1 - .../css/bootstrap-theme.min.css | 5 - blog.bryanroessler.com/css/bootstrap.css | 6566 ----------------- blog.bryanroessler.com/css/bootstrap.css.map | 1 - blog.bryanroessler.com/css/bootstrap.min.css | 5 - blog.bryanroessler.com/css/normalize.css | 427 -- blog.bryanroessler.com/docs/index.html | 25 + blog.bryanroessler.com/feed.xml | 4 + blog.bryanroessler.com/index.html | 65 - blog.bryanroessler.com/js/bootstrap.js | 2306 ------ blog.bryanroessler.com/js/bootstrap.min.js | 7 - .../js/jquery-1.11.2.min.js | 4 - blog.bryanroessler.com/js/main.js | 140 - blog.bryanroessler.com/screenshot.png | Bin 0 -> 61102 bytes blog.bryanroessler.com/staticman.yml | 4 +- blog.bryanroessler.com/tags.html | 8 +- cv.bryanroessler.com/Gemfile.lock | 48 + .../.github/issue_template.md | 4 +- .../.github/workflows/ci.yml | 15 + landing.bryanroessler.com/.gitignore | 4 + landing.bryanroessler.com/404.html | 2 +- landing.bryanroessler.com/CHANGELOG.md | 63 +- landing.bryanroessler.com/Gemfile | 9 +- landing.bryanroessler.com/LICENSE | 13 +- landing.bryanroessler.com/README.md | 324 +- landing.bryanroessler.com/_config.yml | 158 +- .../_data/SocialNetworks.yml | 92 - .../_includes/comments.html | 6 + .../_includes/disqus.html | 24 +- .../_includes/ext-css.html | 4 +- .../_includes/fb-comment.html | 22 +- .../_includes/footer-minimal.html | 20 +- .../_includes/footer-scripts.html | 4 +- .../_includes/footer.html | 51 +- .../_includes/google_analytics.html | 16 +- landing.bryanroessler.com/_includes/gtag.html | 5 +- .../_includes/gtm_body.html | 7 +- .../_includes/gtm_head.html | 16 +- landing.bryanroessler.com/_includes/head.html | 110 +- .../_includes/header.html | 86 +- .../_includes/just_comments.html | 4 - landing.bryanroessler.com/_includes/nav.html | 79 +- .../_includes/readtime.html | 16 + .../_includes/social-networks-links.html | 267 + .../_includes/social-share.html | 17 +- .../_includes/staticman-comments.html | 20 +- .../_includes/utterances-comment.html | 13 + landing.bryanroessler.com/_layouts/base.html | 29 +- .../_layouts/default.html | 2 +- landing.bryanroessler.com/_layouts/home.html | 88 + .../_layouts/minimal.html | 20 +- landing.bryanroessler.com/_layouts/page.html | 17 +- landing.bryanroessler.com/_layouts/post.html | 28 +- landing.bryanroessler.com/aboutme.md | 2 +- .../{ => assets}/css/bootstrap-social.css | 0 .../{ => assets}/css/main-minimal.css | 4 +- .../{ => assets}/css/main.css | 622 +- .../{ => assets}/css/pygment_highlights.css | 0 .../{ => assets}/css/staticman.css | 4 +- .../{ => assets}/img/404-southpark.jpg | Bin .../{ => assets}/img/avatar-icon.png | Bin .../{ => assets}/img/bgimage.png | Bin .../{ => assets}/img/hello_world.jpeg | Bin .../{ => assets}/img/install-steps.gif | Bin .../{ => assets}/img/me_square_bw_small.jpg | Bin .../img/me_square_sepia_small.jpg | Bin .../{ => assets}/img/path.jpg | Bin .../assets/img/thumb.png | Bin 0 -> 396424 bytes .../assets/js/jquery-3.4.1.min.js | 2 + landing.bryanroessler.com/assets/js/main.js | 99 + .../{ => assets}/js/staticman.js | 26 +- .../beautiful-jekyll-theme.gemspec | 26 + .../css/bootstrap-theme.css | 476 -- .../css/bootstrap-theme.css.map | 1 - .../css/bootstrap-theme.min.css | 5 - landing.bryanroessler.com/css/bootstrap.css | 6566 ----------------- .../css/bootstrap.css.map | 1 - .../css/bootstrap.min.css | 5 - landing.bryanroessler.com/css/normalize.css | 427 -- landing.bryanroessler.com/docs/index.html | 25 + landing.bryanroessler.com/feed.xml | 4 + landing.bryanroessler.com/index.html | 8 +- landing.bryanroessler.com/js/bootstrap.js | 2306 ------ landing.bryanroessler.com/js/bootstrap.min.js | 7 - .../js/jquery-1.11.2.min.js | 4 - landing.bryanroessler.com/js/main.js | 140 - landing.bryanroessler.com/screenshot.png | Bin 0 -> 61102 bytes landing.bryanroessler.com/staticman.yml | 4 +- landing.bryanroessler.com/tags.html | 8 +- 145 files changed, 3145 insertions(+), 21875 deletions(-) create mode 100644 blog.bryanroessler.com/.github/workflows/ci.yml delete mode 100644 blog.bryanroessler.com/_data/SocialNetworks.yml create mode 100644 blog.bryanroessler.com/_includes/comments.html delete mode 100644 blog.bryanroessler.com/_includes/just_comments.html create mode 100644 blog.bryanroessler.com/_includes/readtime.html create mode 100644 blog.bryanroessler.com/_includes/social-networks-links.html create mode 100644 blog.bryanroessler.com/_includes/utterances-comment.html create mode 100644 blog.bryanroessler.com/_layouts/home.html rename blog.bryanroessler.com/{ => assets}/css/bootstrap-social.css (100%) rename blog.bryanroessler.com/{ => assets}/css/main-minimal.css (77%) rename blog.bryanroessler.com/{ => assets}/css/main.css (52%) rename blog.bryanroessler.com/{ => assets}/css/pygment_highlights.css (100%) rename blog.bryanroessler.com/{ => assets}/css/staticman.css (98%) rename blog.bryanroessler.com/{ => assets}/img/404-southpark.jpg (100%) rename blog.bryanroessler.com/{ => assets}/img/avatar-icon.png (100%) rename blog.bryanroessler.com/{ => assets}/img/bgimage.png (100%) rename blog.bryanroessler.com/{ => assets}/img/hello_world.jpeg (100%) rename blog.bryanroessler.com/{ => assets}/img/install-steps.gif (100%) rename blog.bryanroessler.com/{ => assets}/img/me_square_bw_small.jpg (100%) rename blog.bryanroessler.com/{ => assets}/img/me_square_sepia_small.jpg (100%) rename blog.bryanroessler.com/{ => assets}/img/path.jpg (100%) create mode 100644 blog.bryanroessler.com/assets/img/thumb.png create mode 100644 blog.bryanroessler.com/assets/js/jquery-3.4.1.min.js create mode 100644 blog.bryanroessler.com/assets/js/main.js rename blog.bryanroessler.com/{ => assets}/js/staticman.js (64%) create mode 100644 blog.bryanroessler.com/beautiful-jekyll-theme.gemspec delete mode 100644 blog.bryanroessler.com/css/bootstrap-theme.css delete mode 100644 blog.bryanroessler.com/css/bootstrap-theme.css.map delete mode 100644 blog.bryanroessler.com/css/bootstrap-theme.min.css delete mode 100644 blog.bryanroessler.com/css/bootstrap.css delete mode 100644 blog.bryanroessler.com/css/bootstrap.css.map delete mode 100644 blog.bryanroessler.com/css/bootstrap.min.css delete mode 100644 blog.bryanroessler.com/css/normalize.css create mode 100644 blog.bryanroessler.com/docs/index.html delete mode 100644 blog.bryanroessler.com/js/bootstrap.js delete mode 100644 blog.bryanroessler.com/js/bootstrap.min.js delete mode 100644 blog.bryanroessler.com/js/jquery-1.11.2.min.js delete mode 100644 blog.bryanroessler.com/js/main.js create mode 100644 blog.bryanroessler.com/screenshot.png create mode 100644 landing.bryanroessler.com/.github/workflows/ci.yml delete mode 100644 landing.bryanroessler.com/_data/SocialNetworks.yml create mode 100644 landing.bryanroessler.com/_includes/comments.html delete mode 100644 landing.bryanroessler.com/_includes/just_comments.html create mode 100644 landing.bryanroessler.com/_includes/readtime.html create mode 100644 landing.bryanroessler.com/_includes/social-networks-links.html create mode 100644 landing.bryanroessler.com/_includes/utterances-comment.html create mode 100644 landing.bryanroessler.com/_layouts/home.html rename landing.bryanroessler.com/{ => assets}/css/bootstrap-social.css (100%) rename landing.bryanroessler.com/{ => assets}/css/main-minimal.css (77%) rename landing.bryanroessler.com/{ => assets}/css/main.css (52%) rename landing.bryanroessler.com/{ => assets}/css/pygment_highlights.css (100%) rename landing.bryanroessler.com/{ => assets}/css/staticman.css (98%) rename landing.bryanroessler.com/{ => assets}/img/404-southpark.jpg (100%) rename landing.bryanroessler.com/{ => assets}/img/avatar-icon.png (100%) rename landing.bryanroessler.com/{ => assets}/img/bgimage.png (100%) rename landing.bryanroessler.com/{ => assets}/img/hello_world.jpeg (100%) rename landing.bryanroessler.com/{ => assets}/img/install-steps.gif (100%) rename landing.bryanroessler.com/{ => assets}/img/me_square_bw_small.jpg (100%) rename landing.bryanroessler.com/{ => assets}/img/me_square_sepia_small.jpg (100%) rename landing.bryanroessler.com/{ => assets}/img/path.jpg (100%) create mode 100644 landing.bryanroessler.com/assets/img/thumb.png create mode 100644 landing.bryanroessler.com/assets/js/jquery-3.4.1.min.js create mode 100644 landing.bryanroessler.com/assets/js/main.js rename landing.bryanroessler.com/{ => assets}/js/staticman.js (64%) create mode 100644 landing.bryanroessler.com/beautiful-jekyll-theme.gemspec delete mode 100644 landing.bryanroessler.com/css/bootstrap-theme.css delete mode 100644 landing.bryanroessler.com/css/bootstrap-theme.css.map delete mode 100644 landing.bryanroessler.com/css/bootstrap-theme.min.css delete mode 100644 landing.bryanroessler.com/css/bootstrap.css delete mode 100644 landing.bryanroessler.com/css/bootstrap.css.map delete mode 100644 landing.bryanroessler.com/css/bootstrap.min.css delete mode 100644 landing.bryanroessler.com/css/normalize.css create mode 100644 landing.bryanroessler.com/docs/index.html delete mode 100644 landing.bryanroessler.com/js/bootstrap.js delete mode 100644 landing.bryanroessler.com/js/bootstrap.min.js delete mode 100644 landing.bryanroessler.com/js/jquery-1.11.2.min.js delete mode 100644 landing.bryanroessler.com/js/main.js create mode 100644 landing.bryanroessler.com/screenshot.png diff --git a/blog.bryanroessler.com/.github/issue_template.md b/blog.bryanroessler.com/.github/issue_template.md index a22cbd3..b3a4ca8 100644 --- a/blog.bryanroessler.com/.github/issue_template.md +++ b/blog.bryanroessler.com/.github/issue_template.md @@ -1,3 +1 @@ -Thank you for submitting an issue! - -Please only submit bug reports or feature suggestions. Please do not submit support requests and general help questions in this forum. +Please only submit feature suggestions or bug reports if you believe something is broken. Please do not submit support requests and general help questions. diff --git a/blog.bryanroessler.com/.github/workflows/ci.yml b/blog.bryanroessler.com/.github/workflows/ci.yml new file mode 100644 index 0000000..dcb9d5a --- /dev/null +++ b/blog.bryanroessler.com/.github/workflows/ci.yml @@ -0,0 +1,15 @@ +name: Beautiful Jekyll CI +on: [push, pull_request] +jobs: + build: + name: Build Jekyll + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - name: Build the site in the jekyll/builder container + run: | + export JEKYLL_VERSION=3.8 + docker run \ + -v ${{ github.workspace }}:/srv/jekyll -v ${{ github.workspace }}/_site:/srv/jekyll/_site \ + -e PAGES_REPO_NWO=${{ github.repository }} \ + jekyll/builder:$JEKYLL_VERSION /bin/bash -c "chmod 777 /srv/jekyll && jekyll build --future" diff --git a/blog.bryanroessler.com/.gitignore b/blog.bryanroessler.com/.gitignore index 001bbf4..5d64240 100644 --- a/blog.bryanroessler.com/.gitignore +++ b/blog.bryanroessler.com/.gitignore @@ -11,3 +11,7 @@ _drafts .DS_Store Thumbs.db ehthumbs.db + +Gemfile.lock + +beautiful-jekyll-theme-*.gem diff --git a/blog.bryanroessler.com/404.html b/blog.bryanroessler.com/404.html index 012e153..340fe9e 100644 --- a/blog.bryanroessler.com/404.html +++ b/blog.bryanroessler.com/404.html @@ -9,5 +9,5 @@ permalink: /404.html

Move along. (404 error)


- + diff --git a/blog.bryanroessler.com/CHANGELOG.md b/blog.bryanroessler.com/CHANGELOG.md index 33fb2b7..edb1cbb 100644 --- a/blog.bryanroessler.com/CHANGELOG.md +++ b/blog.bryanroessler.com/CHANGELOG.md @@ -1,8 +1,65 @@ -# CHANGELOG +## v4.0.1 2020-07-13 -This file lists all non-trivial changes to Beautiful Jekyll. +- Fixed staticman comments UI that was broken since the migration to bootstrap 4 -I often make small changes to documentation, to the demo site, or to the general look-and-feel. These changes will not be listed here. Any other minor changes will also not be listed here. +## v4.0.0 2020-07-12 + +- **BREAKING CHANGE** Replace `image` YAML parameter with `thumbnail-img` to be more clear +- **MAJOR BEHAVIOUR CHANGE** Don't use the thumbnail as the avatar image +- Cover image will automatically be used as thumbnail if none is provided +- Image to share on social media will use the cover image or thumbnail if none is provided +- All images (social media share, thumbnail, cover) can use either relative or absoluate paths. +- Fixed issue where if a dropdown menu was the last item in the menu bar, it did not have a proper margin on the right +- Add social network links: Mastodon (#646), Google Scholar, ORCID (#670) +- Add support for sharing pages on new social network: VK (#657) +- Use Open Graph type 'article' for blog posts (#669) +- Use Twitter's large sumary card (large image) when there is a cover image, thumbnail image, or share image specified (#668) +- Make post images in the feed page smaller on smaller devices +- Fixed jQuery version in staticman (#671) + +## v3.0.0 2020-05-07 + +- **BREAKING CHANGE** Upgraded from Bootstrap 3.3.2 to 4.4.1. This involved a major rewrite of most components. This shouldn't affect any users unless you have custom HTML/CSS code which the new Bootstrap could have broken. +- **BREAKING CHANGE** Renamed `bigimg` YAML parameter to `cover-img` +- **BREAKING CHANGE** Removed `googlefonts` YAML parameter since googlefonts are just CSS so they can be loaded via `ext-css` +- **BREAKING CHANGE** Upgraded from jQuery 1.11.2 to 3.4.2. This should not affect most people +- Added `navbar-border-col` setting in the config file +- Add accessibility features where possible +- Made the theme completely responsive by rewriting all CSS to use 'rem' instead of 'px' +- Rewrite and simplify some JavaScript code to use CSS or Bootstrap alternatives that weren't available in 2015 +- Remove most of the sample posts so that users only have two sample posts to learn from +- Improvements to the README instructions + +## v2.3.0 2020-04-29 + +- Add YAML option `footer-extra` for including custom content in the footer +- Fix issue: linking to a specific part of a page resulted in scrolling too far (#69) +- Add YAML option `nav-short` to have navbar permanently collapsed +- Add social network link: Calendly +- Fix bug where RSS link in footer was showing even when turned off + +## v2.2.0 2020-04-27 + +- Add social network link: Telegram (#625) (thanks @mashed-potatoes) +- Moved the demo site to an independent URL: https://beautifuljekyll.com +- Major documentation overhaul and cleanup of old files +- Fix a few bugs from the remote_theme migration + +## v2.0.0 2020-04-26 + +- Beautiful-Jekyll v2.0.0 available as an official Ruby gem +- Beautifull-Jekyll now supports the `remote_theme` config (#339) (thanks @gpotter2 and @skalee) +- Consolidated the demo site, the ruby gem, and the master branch into one +- Added a `home` layout and used it in the index page +- Added readtime support for the post header (#622) (thanks @MutMatt and @rubyreads) +- Removed the dependency on `_data` folder since it doesn't get copied when using `remote_theme` (#614) +- Added support for configuring lang attribute on `html` tag (#608) (thanks @skalee) +- Added ability to disable round logo (thanks @gpotter2) +- Added support for Utterances comments (#596) (thanks @colynn) +- Removed 'just-comments' as it's getting killed at the end of the year +- Upgraded font-awesome to 5.12.1 (#587) (thanks @cketti) + +## Prior to 2020 **2018-12-24** Add support for Staticman comments (#440) (thanks @VincentTam) diff --git a/blog.bryanroessler.com/Gemfile b/blog.bryanroessler.com/Gemfile index b2c0da4..d1d3708 100644 --- a/blog.bryanroessler.com/Gemfile +++ b/blog.bryanroessler.com/Gemfile @@ -1,4 +1,6 @@ -source 'https://rubygems.org' +# frozen_string_literal: true + +source "https://rubygems.org" + +gemspec -gem 'jekyll', '~>3.8.6', group: :jekyll_plugins -gem 'jekyll-paginate', group: :jekyll_plugins diff --git a/blog.bryanroessler.com/LICENSE b/blog.bryanroessler.com/LICENSE index 1258343..27e2cdf 100644 --- a/blog.bryanroessler.com/LICENSE +++ b/blog.bryanroessler.com/LICENSE @@ -1,6 +1,6 @@ -The MIT License (MIT) +MIT License -Copyright (c) 2015-2018 Dean Attali +Copyright (c) 2020 Dean Attali Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal @@ -19,12 +19,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - - - -staticman integration -================================================================================= - -The MIT License (MIT) - -Copyright (c) 2013-2018 Michael Rose diff --git a/blog.bryanroessler.com/README.md b/blog.bryanroessler.com/README.md index 820f501..22e5c5a 100644 --- a/blog.bryanroessler.com/README.md +++ b/blog.bryanroessler.com/README.md @@ -1,85 +1,108 @@ # Beautiful Jekyll -[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.me/daattali/20) +[![xscode](https://img.shields.io/badge/Available%20on-xs%3Acode-blue?style=?style=plastic&logo=appveyor&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAMAAACdt4HsAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAAZQTFRF////////VXz1bAAAAAJ0Uk5T/wDltzBKAAAAlUlEQVR42uzXSwqAMAwE0Mn9L+3Ggtgkk35QwcnSJo9S+yGwM9DCooCbgn4YrJ4CIPUcQF7/XSBbx2TEz4sAZ2q1RAECBAiYBlCtvwN+KiYAlG7UDGj59MViT9hOwEqAhYCtAsUZvL6I6W8c2wcbd+LIWSCHSTeSAAECngN4xxIDSK9f4B9t377Wd7H5Nt7/Xz8eAgwAvesLRjYYPuUAAAAASUVORK5CYII=)](https://xscode.com/daattali/beautiful-jekyll) [![Gem Version](https://badge.fury.io/rb/beautiful-jekyll-theme.svg)](https://badge.fury.io/rb/beautiful-jekyll-theme) -> *Copyright 2019 [Dean Attali](https://deanattali.com)* +> *Copyright 2020 [Dean Attali](https://deanattali.com)* -**Beautiful Jekyll** is a ready-to-use template to help you create an awesome website quickly. Perfect for personal sites, blogs, or simple project websites. [Check out a demo](https://deanattali.com/beautiful-jekyll) of what you'll get after just two minutes. You can also look at [my personal website](https://deanattali.com) to see it in use, or see examples of websites other people created using this theme [here](#showcased-users-success-stories). +**Beautiful Jekyll** is a ready-to-use template to help you create a beautiful website quickly. Perfect for personal sites, blogs, or simple project websites. [Check out a demo](https://beautifuljekyll.com) of what you'll get after just two minutes. You can also look at [my personal website](https://deanattali.com) to see it in use, or see examples of websites other people created using this theme [below](#showcased-users-success-stories). -**If you enjoy this theme, please consider [supporting me](https://www.paypal.me/daattali/20) for developing and maintaining this template.** +**If you enjoy this theme, please consider [sponsoring me](https://github.com/sponsors/daattali) for developing and maintaining it for over 5 years.**

- - + + + +    + +

-### Table of contents +## Table of contents -- [Prerequisites](#prerequisites) -- [Build your website in 3 steps](#build-your-website-in-3-steps) -- [Add your own content](#add-your-own-content) -- [Last important thing: YAML front matter ("parameters" for a page)](#last-important-thing-yaml-front-matter-parameters-for-a-page) - [Features](#features) -- [Creating a User Page vs a Project Page](#creating-a-user-page-vs-a-project-page) +- [**Build your website in 3 steps**](#build-your-website-in-3-steps) +- [Add your own content](#add-your-own-content) +- [Customizing parameters for each page](#customizing-parameters-for-each-page) +- [Supported parameters](#supported-parameters) - [Showcased users (success stories!)](#showcased-users-success-stories) -- [Advanced: local development](#advanced-local-development-using-docker) - [FAQ and support](#faq-and-support) - [Credits and contributions](#credits) -## Prerequisites +# Features -- You need to have a GitHub account. If you don't have one, [sign up here](https://github.com/join) - it takes one minute. This is where your website will live - if you sign up with username `johnsmith` then your website will be `https://johnsmith.github.io`. -- It would be helpful to understand what Markdown is and how to write it. Markdown is just a way to take a piece of text and format it to look a little nicer. For example, this whole instruction set that you're reading is written in markdown - it's just text with some words being bold/larger/italicized/etc. I recommend taking 5 minutes to learn markdown [with this amazingly easy yet useful tutorial](https://markdowntutorial.com/). +- **SIMPLE**: The primary goal of Beautiful Jekyll is to allow literally *anyone* to create a website in a few minutes. +- **Modern**: Uses the latest best practices and technologies to achieve nearly perfect scores on Google Chrome's Audit. +- **Mobile-first**: Designed to look great on both large-screen and small-screen (mobile) devices. +- **Highly customizable**: Many personalization settings such as changing the background colour/image, adding a logo. +- **Flexible usage**: Use Beautiful Jekyll directly on GitHub or using a Ruby gem - choose the best [development method](#build-your-website-in-3-steps) for you. +- **Battle-tested**: By using Beautiful Jekyll, you'll be joining tens of thousands of users who used this theme since 2015. +- **Links to your social media**: You can easily add links to any of your social media accounts in the footer of every page. +- **Comments support**: Add comments to any page using either [Disqus](https://disqus.com/), [Facebook comments](https://developers.facebook.com/docs/plugins/comments), [Utterances](https://utteranc.es/), or [Staticman](https://staticman.net). +- **Share blog posts on social media**: By default, all blog posts have buttons to allow people to share on Twitter/Facebook/LinkedIn. +- **Tags**: Any blog post can be tagged with keywords, and an index page showing all the tags is automatically generated. +- **Tracking analytics**: Easily integrate Google Analytics, or other analytics platforms, to track visits to your website. +- **Photos support**: Any page can have a cover photo around its title, and any blog post can have an associated image. +- **More advanced features**: I wrote [a blog post](https://deanattali.com/2015/03/12/beautiful-jekyll-how-to-build-a-site-in-minutes/) describing some more advanced features that I used in my website that can be used in any beautiful-jekyll site. -## Build your website in 3 steps +# Build your website in 3 steps + +There's a very easy way to use this theme, and there's a hard way. For most people (including myself!), I suggest going the easy route. If you're an advanced user and want to tinker with the hard way (using ruby gems), then [skip the easy way](https://github.com/daattali/beautiful-jekyll#the-hard-way-using-ruby-gems) if you know what you're doing. + +## The easy way (recommended!) Getting started is *literally* as easy as 1-2-3 :smile: -Scroll down to see the steps involved, but here is a 40-second video just as a reference as you work through the steps. -![Installation steps](img/install-steps.gif) +Scroll down to see the steps involved, but here is a 40-second video just as a reference as you work through the steps. If you don't already have a [GitHub account](https://github.com/join), you'll need to sign up. -### 1. Fork this repository +![Installation steps](assets/img/install-steps.gif) -(Assuming you are on this page and logged into GitHub) Fork this repository by clicking the *Fork* button on the top right corner. Forking means that you now copied this whole project and all the files into your account. +### 1. Fork this project -### 2. Rename the repository to `.github.io` +Fork this project by clicking the __*Fork*__ button at the top right corner of this page. Forking means that you now copied this entire project and all the files into your account. -This will create a GitHub User page ready with the **Beautiful Jekyll** template that will be available at `https://.github.io` within a couple minutes. To do this, click on *Settings* at the top (the cog icon) and there you'll have an option to rename. +### 2. Rename the project to `.github.io` + +Click on __*Settings*__ at the top (the cog icon) and on that page you'll have an option to rename the project (*repository name*). This will create a website with the **Beautiful Jekyll** template that will be available at `https://.github.io` within a couple minutes. Check out the [FAQ](#faq-and-support) if you want to use a different project name. ### 3. Customize your website settings -Edit the `_config.yml` file to change all the settings to reflect your site. To edit the file, click on it and then click on the pencil icon (watch the video tutorial above if you're confused). The settings in the file are fairly self-explanatory and I added comments inside the file to help you further. Any line that begins with a pound sign (`#`) is a comment, and the rest of the lines are actual settings. +Edit the `_config.yml` file to change any settings you want. To edit the file, click on it to view the file and then click on the pencil icon to edit it (watch the video tutorial above if you're confused). The settings in the file are self-explanatory and I added comments inside the file to help you understand what each setting does. Any line that begins with a hashtag (`#`) is a comment, and the other lines are actual settings. -Another way to edit the config file (or any other file) is to use [prose.io](https://prose.io/), which is just a simple interface to allow you to more intuitively edit files or add new files to your project. +### 4. Congratulations! You have a website! -After you save your changes to the config file (by clicking on *Commit changes* as the video tutorial shows), your website should be ready in a minute or two at `https://.github.io`. Every time you make a change to any file, your website will get rebuilt and should be updated in about a minute or so. +After you save your changes to the config file (by clicking on *Commit changes* as the video tutorial shows), your website should be ready in a minute or two at `https://.github.io`. Every time you make a change to any file, your website will get rebuilt and should be updated in about a minute or so. Your website will be initialized with several sample blog posts and a couple other pages. -You can now visit your shiny new website, which will be seeded with several sample blog posts and a couple other pages. Your website is at `https://.github.io` (replace `` with your user name). Do not add `www` to the URL - it will not work! +Note that in the video above I only edited one setting in the `_config.yml` file. **You should actually go through the rest of the settings as well. Don't be lazy, go through all the settings :)** -**Note:** The video above goes through the setup for a user with username `daattalitest`. I only edited one setting in the `_config.yml` file in the video, but **you should actually go through the rest of the settings as well. Don't be lazy, go through all the settings :)** +## The hard way (using ruby gems) -## Add your own content +If you followed the easy method above, then you already have your site and you can skip this section! If you want to install beautiful-jekyll using ruby gems instead, follow the [advanced installation instructions](https://beautifuljekyll.com/getstarted/#install-steps-hard). -To add pages to your site, you can either write a markdown file (`.md`) or you can write an HTML file directly. It is much easier to write markdown than HTML, so I suggest you do that (use the [tutorial I mentioned above](https://markdowntutorial.com/) if you need to learn markdown). You can look at some files on this site to get an idea of how to write markdown. To look at existing files, click on any file that ends in `.md`, for example [`aboutme.md`](./aboutme.md). On the next page you can see some nicely formatted text (there is a word in bold, a link, bullet points), and if you click on the pencil icon to edit the file, you will see the markdown that generated the pretty text. Very easy! -In contrast, look at [`index.html`](./index.html). That's how your write HTML - not as pretty. So stick with markdown if you don't know HTML. +# Add your own content -Any file that you add inside the [`_posts`](./_posts) directory will be treated as a blog entry. You can look at the existing files there to get an idea of how to write blog posts. After you successfully add your own post, you can delete the existing files inside [`_posts`](./_posts) to remove the sample posts, as those are just demo posts to help you learn. +To add pages to your site, you can either write a markdown file (`.md`) or you can write an HTML file. It's much easier to write markdown than HTML, so I suggest you do that ([here's a great tutorial](https://markdowntutorial.com/) if you need to learn markdown in 5 minutes). You can look at some files on this demo site to get an idea of how to write markdown. -As mentioned previously, you can use [prose.io](https://prose.io/) to add or edit files instead of doing it directly on GitHub, it can be a little easier that way. +To look at existing files, click on any file that ends in `.md`, for example [`aboutme.md`](./aboutme.md). On the next page you can see some nicely formatted text (there's a word in bold, a link, a few bullet points), and if you click on the pencil icon to edit the file, you'll see the markdown code that generated the pretty text. Very easy! -## Last important thing: YAML front matter ("parameters" for a page) +In contrast, look at [`tags.html`](./tags.html). That's how your write HTML - not as pretty. So stick with markdown if you don't know HTML. -In order to have your new pages use this template and not just be plain pages, you need to add [YAML front matter](https://jekyllrb.com/docs/front-matter/) to the top of each page. This is where you'll give each page some parameters that I made available, such as a title and subtitle. I'll go into more detail about what parameters are available later. If you don't want to use any parameters on your new page (this also means having no title), then use the empty YAML front matter: +Any markdown or HTML file that you create will be available on your website under `https://.github.io/`. For example, if you create a file `about.md` (or `about.html`) then it'll exist at `https://.github.io/about`. + +Files you create inside the [`_posts`](./_posts) directory will be treated as blog entries. You can look at the existing files there to get an idea of how to write blog posts. Note the format of the blog post files - they must follow the naming convention of `YEAR-MONTH-DAY-title.md`. After you successfully add your own post, you can delete the existing files inside [`_posts`](./_posts) to remove the sample posts, as those are just demo posts to help you learn. + +# Customizing parameters for each page + +**One last important thing**: In order to have your new pages use this template and not just be plain HTML pages, **you must add [YAML front matter](https://jekyllrb.com/docs/front-matter/) to the top of each page**. This is where you'll be able to give each page some extra parameters such as a title, a subtitle, or an image. [Below is a list of all available parameters](#supported-parameters). If you don't want to use any parameters on a page (this also means having no title), then use the empty YAML front matter: ``` --- --- ``` -If you want to use any parameters, write them between the two lines. For example, you can have this at the top of a page: +If you do want to use any parameters, write them between these two lines. For example, you can have this at the top of a page: ``` --- @@ -88,120 +111,77 @@ subtitle: Here you'll find all the ways to get in touch with me --- ``` -You can look at the top of [`aboutme.md`](./aboutme.md) or [`index.html`](./index.html) as more examples. +You can look at the top of [`aboutme.md`](https://raw.githubusercontent.com/daattali/beautiful-jekyll/master/aboutme.md) as an example. -**Important takeaway: ALWAYS add the YAML front matter, which is two lines with three dashes, to EVERY page. If you have any parameters, they go between the two lines.**     -If you don't include YAML then your file will not use the template. +**Important takeaway: ALWAYS add the YAML front matter, which is two lines with three dashes, to EVERY page. If you have any parameters, they go between the two lines.** -## Features +If you don't include YAML then your file will not use this template. -### Mobile-first -**Beautiful Jekyll** is designed to look great on both large-screen and small-screen (mobile) devices. Load up your site on your phone or your gigantic iMac, and the site will work well on both, though it will look slightly different. +# Supported parameters -### Customizable +Below is a list of the parameters that **Beautiful Jekyll** supports (any of these can be added to the YAML front matter of any page). Remember to also look in the `_config.yml` file to see additional settings. -Many personalization settings in `_config.yml`, such as setting your name and site's description, changing the background colour/image, setting your avatar to add a little image in the navigation bar, customizing the links in the menus, customizing what social media links to show in the footer, etc. +## Main paramaters -### Allowing users to leave comments - -If you want to enable comments on your site, Beautiful Jekyll supports either the [Disqus](https://disqus.com/) comments plugin, [Facebook](https://developers.facebook.com/docs/plugins/comments) comments, [Staticman](https://staticman.net) or [JustComments](https://just-comments.com). If any of these are set in the configuration file, then all blog posts will have comments turned on by default. To turn off comments on a particular blog post, add `comments: false` to the YAML front matter. If you want to add comments on the bottom of a non-blog page, add `comments: true` to the YAML front matter. - -#### Disqus comments - -To use Disqus, simply sign up to [Disqus](https://disqus.com/) and add your Disqus shortname to the `disqus` parameter in the `_config.yml` file. - -#### Facebook comments - -To use Facebook comments, create a Facebook app using [Facebook developers](https://developers.facebook.com/docs/apps/register), and add the Facebook App ID to the `fb_comment_id` parameter in `_config.yml`. - -#### Staticman comments - -To use Staticman, you first need to invite `staticmanlab` as a collaborator to your repository (by going to your repository **Settings** page, navigate to the **Collaborators** tab, and add the username `staticmanlab`), and then accept the invitation by going to `https://staticman3.herokuapp.com/v3/connect/github//`. Lastly, fill in the `staticman` parameters in the Staticman section of `_config.yml`. You may also choose a different Staticman instance other than `staticmanlab`. - -Optional: You may want to configure a webhook to prevent old inactive branches (representing approved comments) from stacking up. You can refer to [Staticman's documentation](https://staticman.net/docs/webhooks) for details. Make sure to input the **Payload URL** according to your chosen `endpoint`. For example, the default `endpoint` is `https://staticman3.herokuapp.com/v3/entry/github/`, so the corresponding **Payload URL** should be `https://staticman3.herokuapp.com/v1/webhook`. - -#### JustComments - -To use JustComments you first need to have an account. After you just need to copy the API key to the `just-comments` property in `_config.yml` file. - -### Adding Google Analytics to track page views - -Beautiful Jekyll lets you easily add Google Analytics to all your pages. This will let you track all sorts of information about visits to your website, such as how many times each page is viewed and where (geographically) your users come from. To add Google Analytics, simply sign up to [Google Analytics](https://www.google.com/analytics/) to obtain your Google Tracking ID, and add this tracking ID to the `google_analytics` parameter in `_config.yml`. - -### Sharing blog posts on social media - -By default, all blog posts will have buttons at the bottom of the post to allow people to share the current page on Twitter/Facebook/LinkedIn. You can choose to enable/disable specific social media websites in the `_config.yml` file. You can also turn off the social media buttons on specific blog posts using `social-share: false` in the YAML front matter. - -### RSS feed - -Beautiful Jekyll automatically generates a simple RSS feed of your blog posts, to allow others to subscribe to your posts. If you want to add a link to your RSS feed in the footer of every page, find the `rss: false` line in `_config.yml` and change it to `rss: true`. - -### Page types - -- **post** - To write a blog post, add a markdown or HTML file in the `_posts` folder. As long as you give it YAML front matter (the two lines of three dashes), it will automatically be rendered like a blog post. Look at the existing blog post files to see examples of how to use YAML parameters in blog posts. -- **page** - Any page outside the `_posts` folder that uses YAML front matter will have a very similar style to blog posts. -- **minimal** - If you want to create a page with minimal styling (ie. without the bulky navigation bar and footer), assign `layout: minimal` to the YAML front matter. -- If you want to completely bypass the template engine and just write your own HTML page, simply omit the YAML front matter. Only do this if you know how to write HTML! - -### YAML front matter parameters - -These are the main parameters you can place inside a page's YAML front matter that **Beautiful Jekyll** supports. +These are the basic YAML parameters that you are most likely to use on most pages. Parameter | Description ----------- | ----------- title | Page or blog post title subtitle | Short description of page or blog post that goes under the title -tags | List of tags to categorize the post. Separate the tags with commas and place them inside square brackets. Example: `[personal, self help, finance]` -bigimg | Include a large full-width image at the top of the page. You can either give the path to a single image, or provide a list of images to cycle through (see [my personal website](https://deanattali.com/) as an example). -comments | If you want do add comments to a specific page, use `comments: true`. Comments are automatically enabled on blog posts; to turn comments off for a specific post, use `comments: false`. Comments only work if you enable at least one provider(diqus, staticman, just-comments) in `_config.yml` file. -show-avatar | If you have an avatar configured in the `_config.yml` but you want to turn it off on a specific page, use `show-avatar: false`. If you want to turn it off by default, locate the line `show-avatar: true` in the file `_config.yml` and change the `true` to `false`; then you can selectively turn it on in specific pages using `show-avatar: true`. -image | If you want to add a personalized image to your blog post that will show up next to the post's excerpt and on the post itself, use `image: /path/to/img`. -share-img | If you want to specify an image to use when sharing the page on Facebook or Twitter, then provide the image's full URL here. -social-share | If you don't want to show buttons to share a blog post on social media, use `social-share: false` (this feature is turned on by default). -use-site-title | If you want to use the site title rather than page title as HTML document title (ie. browser tab title), use `use-site-title: true`. When set, the document title will take the format `Site Title - Site Description` (eg. `My website - A virtual proof that name is awesome!`). By default, it will use `Page Title` if it exists, or `Site Title` otherwise. -layout | What type of page this is (default is `post` for blog posts and `page` for other pages. You can use `minimal` if you don't want a header and footer) -js | List of local JavaScript files to include in the page (eg. `/js/mypage.js`) +tags | List of tags to categorize the post. Separate the tags with commas and place them inside square brackets. Example: `[personal, analysis, finance]` +cover-img | Include a large full-width image at the top of the page. You can either provide the path to a single image (eg. `"/path/to/img"`) , or a list of images to cycle through (eg. `["/path/img1", "/path/img2"]`). If you want to add a caption to an image, then the image should be provided as `{"/path/to/img" : "Caption of image"}`. +comments | If you want do add comments to a specific page, use `comments: true`. Comments only work if you enable one of the comments providers (Facebook, disqus, staticman, utterances) in `_config.yml` file. Comments are automatically enabled on blog posts but not on other pages; to turn comments off for a specific post, use `comments: false`. + +## Less commonly used parameters + +These are parameters that you may not use often, but can come in handy sometimes. + +Parameter | Description +----------- | ----------- +readtime | If you want a post to show how many minutes it will take to read it, use `readtime: true`. +show-avatar | If you have an avatar configured in the `_config.yml` but you want to turn it off on a specific page, use `show-avatar: false`. +thumbnail-img | For blog posts, if you want to add a thumbnail that'll show up next to the post's excerpt in the feed, use `thumbnail-img: /path/to/image`. If no thumbnail is provided, then `cover-img` will be used as the thumbnail. You can use `thumbnail-img: ""` to disable a thumbnail. +share-img | The image to use when sharing the page to social media. If not provided, then `cover-img` or `thumbnail-img` will be used. +social-share | By default, every blog post has buttons to share the page on social media. If you want to turn this feature off, use `social-share: false`. +nav-short | By default, the navigation bar gets shorter after scrolling down the page. If you want the navigation bar to always be short on a certain page, use `nav-short: true` +gh-repo   | If you want to show GitHub buttons at the top of a post, this sets the GitHub repo name (eg. `daattali/beautiful-jekyll`). You must also use the `gh-badge` parameter to specify what buttons to show. +gh-badge | Select which GitHub buttons to display. Available options are: [star, watch, fork, follow]. You must also use the `gh-repo` parameter to specify the GitHub repo. +layout | What type of page this is (default is `post` for blog posts and `page` for other pages). See _Page types_ section below for more information. + +## Advanced parameters + +These are advanced parameters that are only useful for people who need very fine control over their website. + +Parameter | Description +----------- | ----------- +footer-extra | If you want to include extra information in the footer, create an HTML file in the `_includes/` folder (for example `_includes/myinfo.html`) and set `footer-extra` to the name of the file (for example `footer-extra: myinfo.html`) +language | HTML language code to be set on the page's <html> element. +use-site-title | If you want to use the site title rather than the page title as the HTML document title, use `use-site-title: true`. +js | List of local JavaScript files to include in the page (eg. `/assets/js/mypage.js`) ext-js | List of external JavaScript files to include in the page (eg. `//cdnjs.cloudflare.com/ajax/libs/underscore.js/1.8.2/underscore-min.js`). External JavaScript files that support [Subresource Integrity (SRI)](https://developer.mozilla.org/en-US/docs/Web/Security/Subresource_Integrity) can be specified using the `href` and `sri` parameters eg.
`href: "//code.jquery.com/jquery-3.1.1.min.js"`
`sri: "sha256-hVVnYaiADRTO2PzUGmuLJr8BLUSjGIZsDYGmIJLv2b8="` css | List of local CSS files to include in the page ext-css | List of external CSS files to include in the page. External CSS files using SRI (see `ext-js` parameter) are also supported. -googlefonts | List of Google fonts to include in the page (eg. `["Monoton", "Lobster"]`) -gh-repo   | If you want to show GitHub buttons at the top of a post, this sets the GitHub repo name (eg. `daattali/beautiful-jekyll`). You must also use the `gh-badge` parameter to specify what buttons to show. -gh-badge | Select which GitHub buttons to display, available options are: [star, watch, fork, follow]. You must also use the `gh-repo` parameter to specify the GitHub repo. -### Advanced features (including how to use a custom URL address for your site) +## Page types -I wrote [a blog post](https://deanattali.com/2015/03/12/beautiful-jekyll-how-to-build-a-site-in-minutes/) describing some more advanced features that I used in my website that are applicable to any Jekyll site. It describes how I used a custom URL for my site (deanattali.com instead of daattali.github.io), how to add a Google-powered search into your site, and provides a few more details about having an RSS feed. +- **post** - To write a blog post, add a markdown or HTML file in the `_posts` folder. As long as you give it YAML front matter (the two lines of three dashes), it will automatically be rendered like a blog post. Look at the existing blog post files to see examples of how to use YAML parameters in blog posts. +- **page** - Any page outside the `_posts` folder that uses YAML front matter will have a very similar style to blog posts. +- **home** - The home layout is meant to act as the homepage of your blog posts - it will display all your blog posts, sorted from newest to oldest. A file using the `home` layout must be named `index.html` (not `index.md` or anything else!). +- **minimal** - If you want to create a page with minimal styling (ie. without the bulky navigation bar and footer), assign `layout: minimal` to the YAML front matter. +- If you want to completely bypass the template engine and just write your own HTML page, simply omit the YAML front matter. Only do this if you know how to write HTML! -## Creating a User Page vs a Project Page +# Showcased users (success stories!) -If you're not sure what the difference is, you can probably safely ignore this section. +Beautiful Jekyll has been used in over 500 websites in its first 6 months, and tens of thousands of times since its inception. Here is a sample of some websites that use Beautiful Jekyll. -If you want to use this theme to host a website that will be available at `https://YOURUSERNAME.github.io`, then you do not need to read this section. That is called a User Page, you can only have one User Page in your GitHub account, and it is what you get by default when forking this project. - -If you want to use this theme to create a website for a particular repository, it will be available at `https://YOURUSERNAME.github.io/PROJECTNAME`, and that is called a [Project Page](https://help.github.com/articles/user-organization-and-project-pages/). You can have a Project Page for any repository you have on GitHub. - -**When using this theme for a Project Page, by default your website will be served from the `gh-pages` branch**, so you must take the following steps: - -1. [Delete the existing `gh-pages` branch](https://help.github.com/en/articles/creating-and-deleting-branches-within-your-repository#deleting-a-branch) - -2. [Create a new branch named `gh-pages` from the `master` branch](https://help.github.com/en/articles/creating-and-deleting-branches-within-your-repository#creating-a-branch) - -Alternatively, instead of the above two steps, you can opt to use the `master` branch instead of `gh-pages` branch as your website's source by choosing that option in the main Settings page. - -## Showcased users (success stories!) - -To my huge surprise, Beautiful Jekyll has been used in over 500 websites in its first 6 months alone! Here is a hand-picked selection of some websites that use Beautiful Jekyll. - -Want your website featured here? [Contact me](https://deanattali.com/aboutme#contact) to let me know about your website. - -### Project/company websites +## Project/company websites | Website | Description | | :------ |:----------- | | [repidemicsconsortium.org/](https://www.repidemicsconsortium.org/) | R Epidemics Consortium | | [vaccineimpact.org](https://www.vaccineimpact.org/) | Vaccine Impact Modelling Consortium | | [derekogle.com/fishR](http://derekogle.com/fishR/) | Using R for Fisheries Analyses | -| [bigdata.juju.solutions](http://bigdata.juju.solutions) | Creating Big Data solutions Juju Solutions | | [joecks.github.io/clipboard-actions](http://joecks.github.io/clipboard-actions/) | Clipboard Actions - an Android app | | [deanattali.com/shinyjs](http://deanattali.com/shinyjs/) | shinyjs - an R package | | [blabel.github.io](http://blabel.github.io) | Library for canonicalising blank node labels in RDF graphs | @@ -212,7 +192,7 @@ Want your website featured here? [Contact me](https://deanattali.com/aboutme#con | [terremotocentroitalia.info](https://www.terremotocentroitalia.info/) | Information about the 2016 Italy earthquake | -### Personal websites +## Personal websites | Website | Who | What | | :------ |:--- | :--- | @@ -228,98 +208,54 @@ Want your website featured here? [Contact me](https://deanattali.com/aboutme#con | [ocram85.com](https://ocram85.com) | Marco Blessing | A personal blog about PowerShell and automation | | [khanna.cc](https://khanna.cc/) | Harry Khanna | Law and software | -## Advanced: Local development using Docker - -Beautiful Jekyll is meant to be so simple to use that you can do it all within the browser. However, if you'd like to develop locally on your own machine, that's possible too if you're comfortable with command line. Follow these simple steps set that up with Docker: - -1. Make sure you have [Docker](https://www.docker.com/) installed. - -2. Clone your repository locally. - - ```bash - git clone https://github.com//.github.io.git - ``` - -3. Run the following shell commands to build the docker image and start the container for the first time: - - ```bash - cd - docker build -t beautiful-jekyll "$PWD" - docker run -d -p 4000:4000 --name beautiful-jekyll -v "$PWD":/srv/jekyll beautiful-jekyll - ``` - - -Now that Docker is set up, you do not need to run the above steps again. You can now view your website at http://localhost:4000/. You can start the container again in the future with: - -```bash -docker start beautiful-jekyll -``` - -And you can stop the server with: - -```bash -docker stop beautiful-jekyll -``` - -Whenever you make any changes to `_config.yml`, you must stop and re-start the server for the new config settings to take effect. - -Disclaimer: I personally am NOT using local development so I don't know much about running Jekyll locally. If you follow this route, please don't ask me questions because unfortunately I honestly won't be able to help! - -## FAQ and support +# FAQ and support If you need any help, I suggest heading over to the [Jekyll support forum](https://talk.jekyllrb.com/). Beautiful Jekyll is actively used by thousands of people with wildly varying degrees of competency, so it's impossible to answer all the questions that may arise. Below are answers to a few very common questions. Most questions that I get asked are not directly related to this theme, and instead are more general questions about Jekyll or web development. Many such questions can be answered by reading the [Jekyll documentation](https://jekyllrb.com/) or with Google. -#### How do I change the number of posts per page OR the colour of the navigation bar OR the image in the navigation bar OR ...? +**If you really wany my personal help, please visit https://xscode.com/daattali/beautiful-jekyll to hire my services.** + +### What if I don't want the website to be `https://.github.io`? + +Every GitHub user can have one repository (repository = project) named `.github.io` and the website for that repository will be `https://.github.io`. + +If you want your project to be named something else, for example `MyAwesomeProject`, that's no problem! All you have to do is go to _Settings_ at the top right corner of the page, and rename your repository to `MyAwesomeProject` (**remember to click on the _Rename_ button to confirm!**). Then you need to scroll down to the _GitHub Pages_ section and choose "master branch" as the source (not "master branch /docs folder"!). + +Now your website will be at `https://.github.io\MyAwesomeProject`. + +### How do I change the number of posts per page OR the colour of the navigation bar OR the image in the navigation bar OR ...? Beautiful Jekyll is built to be very customizable, and as such, many questions about "how do I change ..." can be answered by looking at the `_config.yml` file. The configuration file has many adjustable parameters to customize your site. -#### How do I add a favicon to my site? +### How do I add a favicon to my site? -Easy! Just place a valid `favicon.ico` (or another valid favicon image) in the root directory of your project. And then wait! It can take a while to update. +Easy! Just place a valid `favicon.ico` in the root directory of your project. And then wait! It can take a while to update. -#### How do I move the blog to another page instead of having it on the home page? +### How do I move the blog to another page instead of having it on the home page? The default style of Beautiful Jekyll is to feature the blog feed on the front page. But for many sites that's not the ideal structure, and you may want to have a separate dedicated page for the blog posts. To have the blog hosted on a different URL (for example at `/blog`), copy the `index.html` file into a folder with the same name as the desired page (for example, to `blog/index.html`), and in the `_config.yml` file you need to add a parameter `paginate_path: "//page:num/"` (for example `paginate_path: "/blog/page:num/"`). -#### What size do you recommend using for the `bigimg` photos? +### What size do you recommend using for the `cover-img` photos? Unfortunately, this is a no-answer! There isn't a one-size-fits-all solution to this, because every person will view your site on a different browser with different dimensions. Some browsers will have very wide aspect ratio, some will be narrower, some will be vertical (such as phones), different phones have different screens, etc. The image will always be centered, so the only tip I can give is that you should make sure the important part of the image is in the middle so that it'll always show. Other than that, every browser will show a different clipping of the image. -#### How do I use MathJax equations in my posts? +### How do I use MathJax equations in my posts? MathJax can be easily integrated into your website with a one-line addition. You can see [this discussion](https://github.com/daattali/beautiful-jekyll/issues/195) for more information. -#### My project page appear to be broken after a recent update! +# Contributions -In June 2019, some URL related settings have been adjusted to be more in-line with how Jekyll uses them officially. Project Page absolute links might appear to be broken if you haven't propagated all necessary changes to your local templates, or if you have created additional templates making use of old settings. If a link contains a duplicated project path component, this is most likely the cause. In summary: +Thank you to [all past contributors](https://github.com/daattali/beautiful-jekyll/graphs/contributors). If you find any problems or would like to contribute in any way, feel free to create a pull request/open an issue/send me a message. Any comments are welcome! -|   | Old behavior | New behavior | -| --- | --- | --- | -| `url` setting | `https://user.github.io/projectname` | (unset, GitHub auto detects) | -| `baseurl` setting | `/projectname` | (unset, GitHub auto detects) | -| Absolute link construction | `{{ site.url }}/your/path` | `{{ '/your/path' \| absolute_url }}` | -| Relative link construction | `{{ site.baseurl }}/your/path` | `{{ '/your/path' \| relative_url }}` | +You can also contribute by becoming an [official sponsor](https://github.com/sponsors/daattali) to help keep beautiful-jekyll well-maintained. -## Credits +# Credits -This template was not made entirely from scratch. I would like to give special thanks to: -- [Barry Clark](https://github.com/barryclark) and his project [Jekyll Now](https://github.com/barryclark/jekyll-now), from whom I've taken several ideas and code snippets, as well as some documenation tips. -- [Iron Summit Media](https://github.com/IronSummitMedia) and their project [Bootstrap Clean Blog](https://github.com/IronSummitMedia/startbootstrap-clean-blog), from which I've used some design ideas and some of the templating code for posts and pagination. +This template was not made *entirely* from scratch. I'd like to give special thanks to [Jekyll Now](https://github.com/barryclark/jekyll-now) and [Bootstrap Clean Blog](https://github.com/IronSummitMedia/startbootstrap-clean-blog), from whom I've taken several ideas initially. I'd also like to thank [Dr. Jekyll's Themes](https://drjekyllthemes.github.io/), [Jekyll Themes](http://jekyllthemes.org/), and another [Jekyll Themes](http://jekyllrc.github.io/jekyllthemes/) for featuring Beautiful Jekyll in their Jekyll theme directories. -## Contributions +# Known limitations -If you find anything wrong or would like to contribute in any way, feel free to create a pull request/open an issue/send me a message. Any comments are welcome! - -Thank you to [all contributors](https://github.com/daattali/beautiful-jekyll/graphs/contributors). Special thanks to [@OCram85](https://github.com/OCram85) and [@abelcheung](https://github.com/abelcheung) for contributing multiple times as well as helping with discussions. - -If you do fork or clone this project to use as a template for your site, I would appreciate if you keep the link in the footer to this project. I've noticed that several people who forked this repo removed the attribution and I would prefer to get the recognition if you do use this :) - -## Known limitations - -- If you have a project page and you want a custom 404 page, you must have a custom domain. See https://help.github.com/articles/custom-404-pages/. This means that if you have a regular User Page you can use the 404 page from this theme, but if it's a website for a specific repository, the 404 page will not be used. - -- If there are many navigation bar links and avatar, some of the links may get partially hidden behind the avatar. +- If there are many navigation bar links and an avatar, some of the links may get partially hidden behind the avatar. I suggest either re-thinking the number of links, or not using an avatar. diff --git a/blog.bryanroessler.com/_config.yml b/blog.bryanroessler.com/_config.yml index 100623a..dde3524 100644 --- a/blog.bryanroessler.com/_config.yml +++ b/blog.bryanroessler.com/_config.yml @@ -1,4 +1,4 @@ -# --- General options --- # +# --- Basic options --- # # url is the full website URL # baseurl is the website's URL without the hostname @@ -7,21 +7,11 @@ url: "https://blog.bryanroessler.com" baseurl: "" -# If you are building a GitHub project page then use these settings: -#url: "http://username.github.io/projectname" -#baseurl: "/projectname" +# Your name to show in the footer +author: Bryan Roessler -# Of course don't forget to change the username and projectname to YOUR username and project +# --- List of links in the navigation bar --- # -# Name of website -title: Bryan Roessler - -# Short description of your site -description: Ordo ab chao - -# --- Navigation bar options --- # - -# List of links in the navigation bar navbar-links: Home: "https://bryanroessler.com" Blog: "https://blog.bryanroessler.com" @@ -30,53 +20,36 @@ navbar-links: Services: - Syncthing: "https://syncthing.bryanroessler.com" - Panel: "https://panel.bryanroessler.com" - -# Image to show in the navigation bar - image must be a square (width = height) -# Remove this parameter if you don't want an image in the navbar -avatar: "/img/me_square_sepia_small.jpg" + +# --- Logo --- # # If you want to have an image logo in the top-left corner instead of the title text, # then specify the following parameter #title-img: "./img/me_square_sepia_small.jpg" # --- Background colour/image options --- # +avatar: "/img/me_square_sepia_small.jpg" -# Personalize the colors in your website. Colour values can be any valid CSS colour +# By default, the image is cut into a circle. You can disable this behaviour by setting 'round-avatar: false' +round-avatar: true -navbar-col: "#F5F5F5" -navbar-text-col: "#404040" -navbar-children-col: "#F5F5F5" -page-col: "#FFFFFF" -link-col: "#008AFF" -hover-col: "#0085A1" -footer-col: "#F5F5F5" -footer-text-col: "#777777" -footer-link-col: "#404040" +# If you want to have an image logo in the top-left corner instead of the title text, +# then specify the following parameter +#title-img: /path/to/image -# Alternatively, the navbar, footer, and page background can be set to use background images -# instead of colour - -# navbar-img: "/img/bgimage.png" -# footer-img: "/img/bgimage.png" -# page-img: "/img/bgimage.png" # --- Footer options --- # -# Change all these values or delete the ones you don't want. -# Important: you must keep the "name" parameter, everything else you can remove -author: - name: Bryan Roessler - -# Select your active Social Network Links. -# Uncomment the links you want to show in the footer and add your information to each link. -# You can reorder the items to define the link order. +# Select the social network links that you want to show in the footer. +# Uncomment the links you want to show and add your information to each one. +# If you don't want to show a link to an RSS feed, set rss to "false". # If you want to add a new link that isn't here, you'll need to also edit the file _data/SocialNetworks.yml social-network-links: - rss: true email: "bryanroessler@gmail.com" # facebook: daattali github: "https://git.bryanroessler.com" # twitter: daattali + rss: true # reddit: yourname # google-plus: +DeanAttali linkedin: bryan-roessler-phd-47535a60 @@ -90,18 +63,52 @@ social-network-links: # steam: deanat78 # twitch: yourname # yelp: yourname +# telegram: yourname +# calendly: yourname +# mastodon: instance.url/@username +# ORCID: your ORCID ID +# google-scholar: your google scholar -# Select which share links to show in posts +# --- General options --- # + +# Select which social network share links to show in posts share-links-active: twitter: false facebook: false - google: false linkedin: false + vk: false -# How to display the link to the website in the footer +# 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: "bryanroessler.com" # eg. "deanattali.com/beautiful-jekyll" +# Create a "tags" index page and make tags on each post clickable +link-tags: true + +# Excerpt Word Length - Truncates the excerpt to the specified number of words on the index page +excerpt_length: 50 + +# --- Colours / background image --- # + +# Personalize the colors in your website. Colour values can be any valid CSS colour + +navbar-col: "#F5F5F5" +navbar-text-col: "#404040" +navbar-border-col: "#EAEAEA" +page-col: "#FFFFFF" +link-col: "#008AFF" +hover-col: "#0085A1" +footer-col: "#F5F5F5" +footer-text-col: "#777777" +footer-link-col: "#404040" + +# Alternatively, the navbar, footer, and page background can be set to use background images +# instead of colour + +#navbar-img: "/assets/img/bgimage.png" +#footer-img: "/assets/img/bgimage.png" +#page-img: "/assets/img/bgimage.png" + # --- Web Statistics Section --- # # Fill in your Google Analytics ID to track your website using GA @@ -113,7 +120,6 @@ google_analytics: "UA-158358388-1" # 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" @@ -121,43 +127,50 @@ google_analytics: "UA-158358388-1" # --- Comments --- # -# Fill in your Disqus shortname (NOT the userid) if you want to support Disqus comments -# disqus: "" +# To use Disqus comments, sign up to https://disqus.com and fill in your Disqus shortname (NOT the userid) +#disqus: "" -# If you want to use JustComments fill with the API Key -#just-comments: "ABCD-EFGH-IJKL" +# To use Facebook Comments, create a Facebook app and fill in the Facebook App ID +#fb_comment_id: "" -# To use Facebook Comments, fill in a Facebook App ID -# fb_comment_id: "" +# 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, fill in repository, branch, and endpoint -staticman: - repository : # GitHub username/repository eg. "daattali/beautiful-jekyll" - branch : master # If you're not using `master` branch, then you also need to update the `branch` parameter in `staticman.yml` - endpoint : # URL of your own deployment, with a trailing slash (will fallback to a public GitLab instance) eg. https:///v3/entry/github/ - reCaptcha: - # reCaptcha for Staticman (OPTIONAL, but recommended for spam protection) - # If you use reCaptcha, you must also set these parameters in staticman.yml - siteKey : # Use your own site key, you need to apply for one on Google - secret : # ENCRYPT your password by going to https://staticman3.herokuapp.com/v3/encrypt/ +# To use Staticman comments, first invite `staticmanlab` as a collaborator to your repository and +# accept the invitation by going to `https://staticman3.herokuapp.com/v3/connect/github//`. +# Then uncomment the following section and fill in "repository" and "branch". +# If you want to use reCaptcha for staticman (optional for spam protection), then fill +# in the "siteKey" and "secret" parameters below and also in `staticman.yml`. +# See more details at https://staticman.net/ +#staticman: +# repository : # GitHub username/repository eg. "daattali/beautiful-jekyll" +# branch : master # If you're not using `master` branch, then you also need to update the `branch` parameter in `staticman.yml` +# endpoint : # (optional) URL of your own deployment, with a trailing slash eg. https:///v3/entry/github/ (will fallback to a public GitLab instance) +# reCaptcha: +# siteKey : # Use your own site key, you need to apply for one on Google +# secret : # ENCRYPT your password by going to https://staticman3.herokuapp.com/v3/encrypt/ # --- Misc --- # -# Facebook App ID -# fb_app_id: "" - -# Excerpt Word Length -# Truncates the excerpt to the specified number of words on the index page -excerpt_length: 50 - # Character used to separate site title and description in HTML document title # and RSS feed title title-separator: "-" -# Ruby Date Format +# Ruby Date Format to show dates of posts date_format: "%B %-d, %Y" -# --- Don't need to touch anything below here (but you can if you want) --- # +# 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/New_York" @@ -179,6 +192,7 @@ defaults: layout: "post" comments: true # add comments to all blog posts social-share: true # add social media sharing buttons to all blog posts + readtime: false # add estimated reading time on all blog posts - scope: path: "" # all files @@ -186,74 +200,16 @@ defaults: layout: "page" show-avatar: true -# Use tags index page and make tags on each post clickable -link-tags: true - # Exclude these files from production site exclude: - CHANGELOG.md - CNAME - - Dockerfile - Gemfile - Gemfile.lock - LICENSE - README.md - - Vagrantfile - -#https://github.com/jekyll/jekyll/issues/5267#issuecomment-241379902 -exclude: [vendor] - -# prose.io config -prose: - rooturl: '_posts' - media: 'img' - ignore: - - 404.html - - LICENSE - - feed.xml - - _config.yml - - /_layouts - - /_includes - - /css - - /img - - /js - metadata: - _posts: - - name: "layout" - field: - element: "hidden" - value: "post" - - name: "title" - field: - element: "text" - label: "Post title" - placeholder: "Title" - alterable: true - - name: "subtitle" - field: - element: "textarea" - label: "Subtitle" - placeholder: "A description of your post." - alterable: true - - name: "date" - field: - element: "text" - label: "Date" - help: "Enter date of post." - placeholder: "yyyy-mm-dd" - alterable: true - - name: "image" - field: - element: "text" - label: "Image" - help: "Add a thumbnail image to your post." - placeholder: "Thumbnail" - alterable: true - - name: "published" - field: - element: "checkbox" - label: "Publish" - help: "Check to publish post, uncheck to hide." + - screenshot.png + - docs/ # Beautiful Jekyll / Dean Attali diff --git a/blog.bryanroessler.com/_data/SocialNetworks.yml b/blog.bryanroessler.com/_data/SocialNetworks.yml deleted file mode 100644 index f8d17c7..0000000 --- a/blog.bryanroessler.com/_data/SocialNetworks.yml +++ /dev/null @@ -1,92 +0,0 @@ -# You can define your custom social network links here. -# Use the same key you added in _config.yml -> social-network-links. -# In addition to that you need to specify the following properties: -# name: Specify a user-friendly name that will be used as a link title -# baseURL: Define a base URL which will be combined with the value of -# site.social-network-links. -# icon: Specify a valid fontawesome icon class - -facebook: - name: "Facebook" - baseURL: "https://www.facebook.com/" - icon: "fa-facebook" - -github: - name: "GitHub" - baseURL: "https://github.com/" - icon: "fa-github" - -twitter: - name: "Twitter" - baseURL: "https://twitter.com/" - icon: "fa-twitter" - -reddit: - name: "Reddit" - baseURL: "https://reddit.com/u/" - icon: "fa-reddit" - -email: - name: "Email me" - baseURL: "mailto:" - icon: "fa-envelope" - -linkedin: - name: "LinkedIn" - baseURL: "https://linkedin.com/in/" - icon: "fa-linkedin" - -xing: - name: "Xing" - baseURL: "https://www.xing.com/profile/" - icon: "fa-xing" - -stackoverflow: - name: "StackOverflow" - baseURL: "https://stackoverflow.com/users/" - icon: "fa-stack-overflow" - -snapchat: - name: "Snapchat" - baseURL: "https://www.snapchat.com/add/" - icon: "fa-snapchat-ghost" - -instagram: - name: "Instagram" - baseURL: "https://www.instagram.com/" - icon: "fa-instagram" - -youtube: - name: "YouTube" - baseURL: "https://www.youtube.com/" - icon: "fa-youtube" - -spotify: - name: "Spotify" - baseURL: "https://open.spotify.com/user/" - icon: "fa-spotify" - -telephone: - name: "Phone" - baseURL: "tel:" - icon: "fa-phone" - -rss: - name: "RSS" - baseURL: "{{ '/feed.xml' | relative_url }}" - icon: "fa-rss" - -steam: - name: "Steam" - baseURL: "https://steamcommunity.com/id/" - icon: "fa-steam" - -twitch: - name: "Twitch" - baseURL: "https://www.twitch.tv/" - icon: "fa-twitch" - -yelp: - name: "Yelp" - baseURL: "https://{{ site.author.yelp }}.yelp.com" - icon: "fa-yelp" diff --git a/blog.bryanroessler.com/_includes/comments.html b/blog.bryanroessler.com/_includes/comments.html new file mode 100644 index 0000000..5afdf39 --- /dev/null +++ b/blog.bryanroessler.com/_includes/comments.html @@ -0,0 +1,6 @@ +{% if page.comments %} + {% include disqus.html %} + {% include fb-comment.html %} + {% include staticman-comments.html %} + {% include utterances-comment.html %} +{% endif %} \ No newline at end of file diff --git a/blog.bryanroessler.com/_includes/disqus.html b/blog.bryanroessler.com/_includes/disqus.html index dd80975..d1c5575 100644 --- a/blog.bryanroessler.com/_includes/disqus.html +++ b/blog.bryanroessler.com/_includes/disqus.html @@ -1,17 +1,19 @@ {%- if site.disqus -%} -
+
+
- + +
{%- endif -%} diff --git a/blog.bryanroessler.com/_includes/ext-css.html b/blog.bryanroessler.com/_includes/ext-css.html index 3becb23..c177a7c 100644 --- a/blog.bryanroessler.com/_includes/ext-css.html +++ b/blog.bryanroessler.com/_includes/ext-css.html @@ -1,7 +1,7 @@ {% if include.css.sri %} {% elsif include.css.href %} - + {% else %} - + {% endif %} diff --git a/blog.bryanroessler.com/_includes/fb-comment.html b/blog.bryanroessler.com/_includes/fb-comment.html index f358061..d29682c 100644 --- a/blog.bryanroessler.com/_includes/fb-comment.html +++ b/blog.bryanroessler.com/_includes/fb-comment.html @@ -1,14 +1,16 @@ {%- if site.fb_comment_id -%}
-
- -
- +
+ +
+
{%- endif -%} diff --git a/blog.bryanroessler.com/_includes/footer-minimal.html b/blog.bryanroessler.com/_includes/footer-minimal.html index 3e76cbf..c6a5af5 100644 --- a/blog.bryanroessler.com/_includes/footer-minimal.html +++ b/blog.bryanroessler.com/_includes/footer-minimal.html @@ -1,16 +1,18 @@
- {{ site.author.name }} -   •   - {% if page.date %} - {{ page.date }} - {% else %} - {{ site.time | date: '%Y' }} - {% endif %} + {% if site.author %} + {{ site.author }} +   •   + {% endif %} + {% if page.date %} + {{ page.date }} + {% else %} + {{ site.time | date: '%Y' }} + {% endif %} {% if site.url-pretty %} -   •   - {{ site.url-pretty }} +   •   + {{ site.url-pretty }} {% endif %}
diff --git a/blog.bryanroessler.com/_includes/footer-scripts.html b/blog.bryanroessler.com/_includes/footer-scripts.html index 8b36e48..a87f0be 100644 --- a/blog.bryanroessler.com/_includes/footer-scripts.html +++ b/blog.bryanroessler.com/_includes/footer-scripts.html @@ -9,9 +9,9 @@ {% if js contains 'jquery' %} {% else %} diff --git a/blog.bryanroessler.com/_includes/footer.html b/blog.bryanroessler.com/_includes/footer.html index bff9d58..91ff90d 100644 --- a/blog.bryanroessler.com/_includes/footer.html +++ b/blog.bryanroessler.com/_includes/footer.html @@ -1,36 +1,23 @@