diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 000000000000..c1d2ba2b3c75 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,48 @@ +# Define standard eol format + +# Web Files +*.html text eol=lf +*.md text eol=lf +*.css text eol=lf +*.js text eol=lf + +# Jekyll related files +*.yml text eol=lf + +# Git related files +.gittattributes text eol=lf +.gitignore text eol=lf +.gitkeep text eol=lf + +# Ruby files +*.rb text eol=lf +Gemfile text eol=lf +Gemfile.lock text eol=lf + +# Github specific fies +LICENCE text eol=lf + +# Docker specific files +Dockerfile text eol=lf + +# VSCode files +*.json text eol=lf + +# General multimedia files +*.jpg binary +*.jpeg binary +*.gif binary +*.png binary +*.t3x binary +*.t3d binary +*.exe binary +*.data binary +*.ttf binary +*.eof binary +*.eot binary +*.swf binary +*.mov binary +*.mp4 binary +*.mp3 binary +*.ogg binary +*.flv binary diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 000000000000..fb01171151fd --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,4 @@ +# These are supported funding model platforms + +github: daattali +patreon: DeanAttali diff --git a/.github/issue_template.md b/.github/issue_template.md new file mode 100644 index 000000000000..2e25e5c9e57e --- /dev/null +++ b/.github/issue_template.md @@ -0,0 +1,3 @@ +Please only submit feature suggestions or bug reports if you believe something is broken. + +If you need help, you can attend the [Office Hours](https://beautifuljekyll.com/officehours) (only available for [sponsors](https://beautifuljekyll.com/plans/)). diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000000..a30e7e4a731d --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,5 @@ +Please note that if you are trying to update **your** website, this is the wrong place to do so. Please carefully follow the Beautiful Jekyll instructions (found at https://github.com/daattali/beautiful-jekyll#readme) and make sure you submit changes to **your** version of the project. + +If your intention is to submit a Pull Request, please describe what your pull request achieves. + +Thank you! diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 000000000000..e684fb8c84aa --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,26 @@ +name: Beautiful Jekyll CI +on: [push, pull_request] +jobs: + build: + name: Build Jekyll + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: ruby/setup-ruby@v1 + with: + ruby-version: '3.3' + - name: Install dependencies + run: bundle install && bundle exec appraisal install + - name: Setup Pages + id: configure-pages + uses: actions/configure-pages@v5 + - name: Setup CI config + run: | + echo "---" > _config_ci.yml + echo "baseurl: ${{ steps.configure-pages.outputs.base_path }}" >> _config_ci.yml + - name: Build site + env: + JEKYLL_ENV: production + run: bundle exec appraisal jekyll build --future --config _config_ci.yml,_config.yml + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 diff --git a/.gitignore b/.gitignore index 72e4fbb805c7..e065359ac1ef 100644 --- a/.gitignore +++ b/.gitignore @@ -6,4 +6,8 @@ _site # general .DS_Store Thumbs.db -ehthumbs.db \ No newline at end of file +ehthumbs.db + +Gemfile.lock + +beautiful-jekyll-theme-*.gem diff --git a/404.html b/404.html index 012e15334f51..9bdd8eae7ec9 100644 --- a/404.html +++ b/404.html @@ -9,5 +9,5 @@

Whoops, this page doesn't exist.

Move along. (404 error)


- + Not found diff --git a/Appraisals b/Appraisals new file mode 100644 index 000000000000..dac8cfe0ffb0 --- /dev/null +++ b/Appraisals @@ -0,0 +1,6 @@ +appraise "jekyll-3" do + gem "jekyll", "3.9.4" +end +appraise "jekyll-4" do + gem "jekyll", "4.3.3" +end diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 000000000000..54a1c79014d1 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,250 @@ +## Unreleased version +- BREAKING CHANGE: Allow changing the order of the social network links that appear in the footer (#1152) +- BREAKING CHANGE: `google-scholar` social network link no longer requires the prefix `citations?user=`; if you previously set this parameter, it needs to be updated (#1189) +- Added `mathjax` YAML parameter to allow support for MathJax, used to write LaTeX expressions (#195) +- Added explicit support for favicons, you only need to add a `favicon.ico` file to the root directory +- The footer of a page always sticks to the bottom, even on short pages (#576) +- Added `author` YAML parameter to allow specifying the author(s) of a post (#1220) +- Fixed bug where search results broke if a post title had a backslash (#1279) +- Fixed bug where hovering over search results showed the text "{desc}" (#1156) +- Added social network links for GitLab, Bluesky, Whatsapp, Untappd, Strava (#1168, #1218, #1299, #1307, #1443) +- Support reddit social network link to either be a subreddit or a user (#1371) +- Use CSS variables (#661) +- Added instructions and example on how to fix image links in project sites (#1171) +- Pagination buttons: use nicer arrows, and don't show text on small screens (#1221) +- Updated Yelp URL format - if you previously used the `yelp` social network config parameter, you might need to update the config value (#1259) +- Added `title-on-all-pages` config setting, that adds the website title to all page titles (#1272) +- Change Twitter icon to X (#1193) +- Upgraded font-awesome to 6.5.2 (#1330) +- Fixed tables not having a scroll bar when wider than the page (usually happened on mobile) (#1452) +- Add author name to RSS feed (#1442) + +## v6.0.1 (2023-06-08) + +This version has been in the works for a few years. It includes several new features that were highly requested, numerous bug fixes, new documentation, and aggresively encourages migrating from the old Google Universal Analytics to the new Analytics 4. + +#### Breaking changes + +- As of July 2023, Google Universal Analytics is going away and being replaced by Google Analytics 4. Beautiful Jekyll sites that still use the old analytics tag will show a warning to encourage them to move to Analytics 4 (#1096). +- More control over RSS feed sharing: previously, an RSS feed was *always* generated, and if the config setting `rss-description` was set then there was an RSS icon in the footer. Now, an RSS feed is only generated when the config setting `rss-description` exists, and an RSS footer icon is only shown if `rss: true` is set in the `social-network-links` config settings. + +#### New parameters and settings + +- Added `navbar-var-length` config setting that allows the navigation menu to be the same length as the longest sub-menu, so that long words in the submenu are not cut off (#765) +- Added `post_search` config setting that creates a Search button in the navbar (#770) +- Added `edit_page_button` config setting that adds a "Edit page" button to the footer (to edit the current page on GitHub) (#1004) +- Added `footer-hover-col` config setting to customize the hover colour of links in the footer (#848) + +#### New features and improvements + +- Made the home page feed more accessible for screen readers (#950) +- Added support for giscus comments (#886) and CommentBox (#960) +- Added support for Cloudflare Analytics (#797) +- Added Reddit in share options of posts (#815) + +#### Bug fixes + +- Fixed page titles, subtitles, and excerpts rendering correctly when there are special characeters in them (#856) +- Fixed bug where navbar secondary level dropdown items didn't inherit the same colour as the primary navbar links +- Fixed bug where the navbar "burger" collapsed button didn't always revert back to a light colour +- Fixed bug where using an image as a navbar title did not render in GitHub Project pages that did not have a custom domain +- Fixed bug where image thumbnails on the feed page were always forced into a square rather than maintaining a proper image aspect ratio +- Fixed bug where special characters in the title led to broken share tags (#744) +- Fixed bug where staticman didn't work jQuery slim version is used (#766) +- Fixed very long strings to wrap around the next line rather than go off-screen (#787) + +#### Small changes + +- Updated staticman from using v2 (public servers) to v3 (private servers) due to the public servers becoming obsolete (#775) +- Added social network links for Patreon, Medium, Itch.io, Discord, Kaggle, Hackerrank (#783, #788, #907, #961, #978) +- Slightly reworked margins and position for avatar image to resolve an alignment issue on Safari +- Changed the width at which the navbar collapses to a higher threshold because most modern non-mobile browsers are >1000px + + +## v5.0.0 (2020-09-15) + +One of the major changes in this version is that a lot of time was spent on rethinking the entire SEO and social media sharing model (how a page looks on eg. Google, Twitter, Facebok). It was redesigned to be more simple and customizable. The new documentation has a section dedicated to SEO and social media sharing of a page. Unfortunately some changes that are not backwards-compatible had to be made. + +#### Breaking changes + +- Renamed `description` YAML parameter to `share-description` to be more clear +- Renamed `description` config setting to `rss-description` since it was only used in RSS (the FAQ explains the difference between YAML parameters and config settings if you're confused) +- Removed YAML parameter `use-site-title` (you can now specify the exact title using `share-title`) +- Removed undocumented YAML parameters `meta-title` and `meta-description` +- Removed `link-tags` config setting because it wasn't necessary. If you use tags, there will now always be a tags page created; if you don't use tags there won't be a tags page. +- The YAML parameter `show-avatar` is now true by default. This has always been the case for GitHub Pages users, but not for `remote_theme` users. For consistency, it's now the default for everyone. (#715) + +#### New parameters and settings + +- Added `full-width` YAML parameter to allow having full-width pages +- Added `feed_show_excerpt` config setting to show/hide the post excerpts on the feed page +- Added `feed_show_tags` config setting to show/hide the list of tags on post previews on the feed page +- Added `share-title` YAML parameter to give control over the search engine/social media title +- Added `last-updated` YAML parameter to show a "Last Updated on" date for blog posts +- Added `before-content` and `after-content` YAML parameters that allow you to add some common HTML before the main content of a page (below the title) or after the main content (above the footer). Works in a similar way to `footer-extra`. +- Added `head-extra` YAML parameter which is similar to `footer-extra` but is used to include custom HTML code in a page's `` tag +- Added `site-js` config setting to provide JavaScript files that are used on all pages in the site + +#### New features and improvements + +- Improved the `footer-extra` YAML parameter to support multiple files instead of only a single file +- Added automatic navbar color detection (#702) +- When `nav-short` is turned on, the avatar will also be shorter +- Changed navbar and footer background colour to be slightly darker, for better contrast with the default white page background for accessibility reasons +- Changed the behaviour of `site-css` to include site-wide CSS file **before** instead of after page-specific files +- Renamed internal css/js files from "main" to "beautifuljekyll" to make it easier for users to troubleshoot +- Added alt text to all images for better accessibility +- Made thumbnail images square instead of circles, as users reported that circles cut off important parts of images + +#### Bug fixes + +- Fixed rendering issues with `nav-short` parameter that caused the body of the page to start too low +- Fixed some CSS styles that broke during the bootstrap 4 migration (#716) + +#### Library upgrades + +- Upgraded kramdown to version 2.3.0 to fix security issues +- Upgraded jQuery to version 3.5.1 to fix a couple security vulnerabilities with the previous version + +## v4.1.0 (2020-08-08) + +- Added Open Graph `site_name` meta field to pages automatically +- Added `text-col` config setting for main text color (#694) +- Added `keywords` config setting to set the meta keywords on all pages (for SEO purposes) (#691) +- Added `mobile-theme-col` config setting to allow a mobile theme colour (#692) +- Added `site-css` config setting in the config file to provide CSS files that are used on all pages in the site (#695) +- Added YAML parameter `description`: creates the meta description on a page, intended to provide a brief description of the page for search engines and when the page is shared (#690) + +## v4.0.1 (2020-07-13) + +- Fixed staticman comments UI that was broken since the migration to bootstrap 4 + +## 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 +- Added social network links: Mastodon (#646), Google Scholar, ORCID (#670) +- Added 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) +- Made 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 +- Added accessibility features where possible +- Made the theme completely responsive by rewriting all CSS to use 'rem' instead of 'px' +- Rewrote and simplified some JavaScript code to use CSS or Bootstrap alternatives that weren't available in 2015 +- Removed 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) + +- Added YAML parameter `footer-extra` for including custom content in the footer +- Fixed issue: linking to a specific part of a page resulted in scrolling too far (#69) +- Added YAML parameter `nav-short` to have navbar permanently collapsed +- Added social network link: Calendly +- Fixed bug where RSS link in footer was showing even when turned off + +## v2.2.0 (2020-04-27) + +- Added 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 +- Fixed 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) + +**2018-10-19** Move Google Analytics to the head (#419) (thanks @jpvicari) + +**2018-06-08** Add support for Facebook comments (#350) (thanks @npes87184) + +**2018-02-22** Automatically generate sitemap (#323) (thanks @JosemyDuarte) + +**2018-01-18** Add clickable tags to each post and a tags index page, works for GitHub sites (#307) (thanks @OCram85) + +**2018-01-14** Redo Dockerfile (#302) (thanks @jennydaman) + +**2018-01-06** More color personalization options (#297 and #299) (thanks @jennydaman) + +**2018-01-05** Abstract the social networks logic (thanks @OCram85) + +**2018-01-03** Avatar image no longer causes a ghost click (thanks @alefi87) + +**2017-10-16** Add GitHub buttons to posts (#265) (thanks @yonicd) + +**2017-09-04** Ability to change colour/image of navbar/footer/body + +**2017-08-17** Add support for notification, error, and warning boxes in markdown (#227) (thanks @OCram85) + +**2017-08-12** Add social buttons for twitch, yelp, and steam (#234) (thanks @TheRealBenForce) + +**2017-03-30** Make the footer contact links friendly for screen readers (thanks @eugenius1) + +**2017-03-30** Started a CHANGELOG file (thanks @eugenius1) + +**2017-01-28** Add Subresource Integrity (SRI) support (#164) (thanks @tony-ho) + +**2017-01-09** Add Google Tag Manager Integration (#157) (thanks @csarigoz) + +**2017-01-06** Add options to configure HTML document title (#154) (thanks @tony-ho) + +**2016-12-25** Allow dynamic images on each blog post (#143) (thanks @bbritten) + +**2016-12-15** Support `title-img` config param to have image in the navbar instead of text + +**2016-12-08** Add support for phone numbers in footer; fix #136 + +**2016-12-06** Update gemfile (#134) (thanks @stephentuso) + +**2016-10-09** Add Docker deployment (#114) (thanks @mangar) + +**2016-08-06** Add social share buttons for posts (thanks @rtlee9) + +**2016-07-29** Add CSS styling to code chunks + +**2016-07-27** Add clickable tags that lead to a tag page (doesn't work for GitHub hosted sites) (thanks @epwalsh) + +**2016-07-21** Add support for twitter cards (sharing on Twitter will be better); fixes #70 + +**2016-03-18** Support full-width images in page headers; fixes #37 + +**2016-03-18** Support menus in navigation bar + +**2016-02-07** Avatar is now conditional (thanks @hristoyankov) + +**2016-02-02** Migrate (forced to...) to jekyll 3 + +**2016-01-22** Make sure not to include JQuery twice, fixes #29 + +**2015-11-19** Support external links in navigation bar; fixes #3 + +... Many small changes because the site was in its infancy + +**2015-03-12** Beautiful Jekyll version 0.0000001 is released! + diff --git a/Gemfile b/Gemfile index 451cea6dd87d..abae4defafe5 100644 --- a/Gemfile +++ b/Gemfile @@ -1,6 +1,16 @@ -source 'https://rubygems.org' - -gem 'execjs' -gem 'therubyracer' -gem 'github-pages' -gem 'jekyll-paginate' \ No newline at end of file +# frozen_string_literal: true + +source "https://rubygems.org" + +# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem +# and associated library. +platforms :mingw, :x64_mingw, :mswin, :jruby do + gem "tzinfo", ">= 1", "< 3" + gem "tzinfo-data" +end + +# Performance-booster for watching directories on Windows +gem "wdm", "~> 0.1", :platforms => [:mingw, :x64_mingw, :mswin] + +gemspec + diff --git a/Gemfile.lock b/Gemfile.lock deleted file mode 100644 index 37f3e83f001c..000000000000 --- a/Gemfile.lock +++ /dev/null @@ -1,136 +0,0 @@ -GEM - remote: https://rubygems.org/ - specs: - activesupport (4.2.6) - i18n (~> 0.7) - json (~> 1.7, >= 1.7.7) - minitest (~> 5.1) - thread_safe (~> 0.3, >= 0.3.4) - tzinfo (~> 1.1) - addressable (2.4.0) - coffee-script (2.4.1) - coffee-script-source - execjs - coffee-script-source (1.10.0) - colorator (0.1) - ethon (0.9.0) - ffi (>= 1.3.0) - execjs (2.7.0) - faraday (0.9.2) - multipart-post (>= 1.2, < 3) - ffi (1.9.10) - gemoji (2.1.0) - github-pages (82) - github-pages-health-check (= 1.1.0) - jekyll (= 3.1.6) - jekyll-coffeescript (= 1.0.1) - jekyll-feed (= 0.5.1) - jekyll-gist (= 1.4.0) - jekyll-github-metadata (= 2.0.0) - jekyll-mentions (= 1.1.2) - jekyll-paginate (= 1.1.0) - jekyll-redirect-from (= 0.10.0) - jekyll-sass-converter (= 1.3.0) - jekyll-seo-tag (= 2.0.0) - jekyll-sitemap (= 0.10.0) - jemoji (= 0.6.2) - kramdown (= 1.10.0) - liquid (= 3.0.6) - listen (= 3.0.6) - mercenary (~> 0.3) - rouge (= 1.10.1) - terminal-table (~> 1.4) - github-pages-health-check (1.1.0) - addressable (~> 2.3) - net-dns (~> 0.8) - octokit (~> 4.0) - public_suffix (~> 1.4) - typhoeus (~> 0.7) - html-pipeline (2.4.1) - activesupport (>= 2, < 5) - nokogiri (>= 1.4) - i18n (0.7.0) - jekyll (3.1.6) - colorator (~> 0.1) - jekyll-sass-converter (~> 1.0) - jekyll-watch (~> 1.1) - kramdown (~> 1.3) - liquid (~> 3.0) - mercenary (~> 0.3.3) - rouge (~> 1.7) - safe_yaml (~> 1.0) - jekyll-coffeescript (1.0.1) - coffee-script (~> 2.2) - jekyll-feed (0.5.1) - jekyll-gist (1.4.0) - octokit (~> 4.2) - jekyll-github-metadata (2.0.0) - jekyll (~> 3.1) - octokit (~> 4.0) - jekyll-mentions (1.1.2) - html-pipeline (~> 2.3) - jekyll (~> 3.0) - jekyll-paginate (1.1.0) - jekyll-redirect-from (0.10.0) - jekyll (>= 2.0) - jekyll-sass-converter (1.3.0) - sass (~> 3.2) - jekyll-seo-tag (2.0.0) - jekyll (~> 3.1) - jekyll-sitemap (0.10.0) - jekyll-watch (1.4.0) - listen (~> 3.0, < 3.1) - jemoji (0.6.2) - gemoji (~> 2.0) - html-pipeline (~> 2.2) - jekyll (>= 3.0) - json (1.8.3) - kramdown (1.10.0) - libv8 (3.16.14.15) - liquid (3.0.6) - listen (3.0.6) - rb-fsevent (>= 0.9.3) - rb-inotify (>= 0.9.7) - mercenary (0.3.6) - mini_portile2 (2.1.0) - minitest (5.9.0) - multipart-post (2.0.0) - net-dns (0.8.0) - nokogiri (1.6.8) - mini_portile2 (~> 2.1.0) - pkg-config (~> 1.1.7) - octokit (4.3.0) - sawyer (~> 0.7.0, >= 0.5.3) - pkg-config (1.1.7) - public_suffix (1.5.3) - rb-fsevent (0.9.7) - rb-inotify (0.9.7) - ffi (>= 0.5.0) - ref (2.0.0) - rouge (1.10.1) - safe_yaml (1.0.4) - sass (3.4.22) - sawyer (0.7.0) - addressable (>= 2.3.5, < 2.5) - faraday (~> 0.8, < 0.10) - terminal-table (1.6.0) - therubyracer (0.12.2) - libv8 (~> 3.16.14.0) - ref - thread_safe (0.3.5) - typhoeus (0.8.0) - ethon (>= 0.8.0) - tzinfo (1.2.2) - thread_safe (~> 0.1) - -PLATFORMS - ruby - -DEPENDENCIES - execjs - github-pages - jekyll-paginate - therubyracer - -BUNDLED WITH - 1.12.5 diff --git a/LICENSE b/LICENSE index 72fab4a3dc79..0b6ae57226ca 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ -The MIT License (MIT) +MIT License -Copyright (c) 2016 Dean Attali +Copyright (c) 2023 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 diff --git a/README.md b/README.md index 62fe6436e251..c2d1c5a39d6a 100644 --- a/README.md +++ b/README.md @@ -1,79 +1,121 @@ # Beautiful Jekyll -> *Copyright 2016 [Dean Attali](http://deanattali.com). Licensed under the MIT license.* +[![Gem Version](https://badge.fury.io/rb/beautiful-jekyll-theme.svg)](https://badge.fury.io/rb/beautiful-jekyll-theme) -**Beautiful Jekyll** is a ready-to-use template to help you create an awesome website quickly. Perfect for personal blogs or simple project websites. [Check out a demo](http://deanattali.com/beautiful-jekyll) of what you'll get after just two minutes. You can also look at [my personal website](http://deanattali.com) to see it in use, or see examples of websites other people created using thcois theme [here](#featured-users-success-stories). +> By [Dean Attali](https://deanattali.com) · [Demo](https://beautifuljekyll.com/) -If you need a bit of help or have comments, feel free to [contact me](http://deanattali.com/aboutme#contact). Even if you don't have anything important to say but found this useful, I'd love to [hear about it](http://deanattali.com/aboutme#contact). Lastly, if you like this theme, please consider [supporting me](https://www.paypal.me/daattali/20) if you want to make me extra happy. :) +**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) or [my consulting website](https://attalitech.com) to see it in use, or see [examples of websites](http://beautifuljekyll.com/examples) other people created using this theme. -This template is built on top of [Jekyll](http://jekyllrb.com/) and can be used for any [GitHub Pages](https://pages.github.com/) website. (If you don't know what these two things are, that's absolutely fine, you don't need to!) +**If you enjoy Beautiful Jekyll, please consider [supporting me](https://github.com/sponsors/daattali). You'll also gain access to office hours and more features! ❤** -### Table of contents +## Table of contents -- [Prerequisites](#prerequisites) -- [Build your website in 3 steps](#build-your-website-in-3-steps) +- [Features](#features) +- [Sponsors 🏆](#sponsors) +- [**Build your website in 3 steps**](#build-your-website-in-3-steps) +- [Plans](#plans) - [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) -- [Basic features](#basic-features) -- [Advanced features](#advanced-features-including-how-to-use-a-custom-url-address-for-your-site) +- [Customizing parameters for each page](#customizing-parameters-for-each-page) +- [Supported parameters](#supported-parameters) - [Featured users (success stories!)](#featured-users-success-stories) -- [Very advanced: local development](#very-advanced-local-development) -- [Credits](#credits) -- [Contributions](#contributions) -- [Known limitations](#known-limitations) +- [Next steps](#next-steps) +- [Getting help](#getting-help) +- [Credits and contributions](#contributions) -## 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 `http://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](http://markdowntutorial.com/). +__Check out [*What's New?*](https://beautifuljekyll.com/updates/) to see the latest features!__ -## Build your website in 3 steps +- **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 via 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 50,000+ users enjoying this theme since 2015. +- **SEO and social media support**: Customize how your site looks on Google and when shared on social media. +- **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/), [Staticman](https://staticman.net), [giscus](https://giscus.app), or [CommentBox](https://commentbox.io/). +- **Tags**: Any blog post can be tagged with keywords, and an index page is automatically generated. +- **Analytics**: Easily integrate Google Analytics, or other analytics platforms, to track visits to your website. +- **Search**: Let users easily find any page using a Search button in the navigation bar. +- **Photos support**: Any page can have a full-width cover photo and thumbnail. +- **RSS**: An RSS feed is automatically created, so you can even host a podcast easily with Beautiful Jekyll. -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. +

Sponsors 🏆

-![Installation steps](img/install-steps.gif) +Developing and maintaining Beautiful Jekyll takes a lot of time and effort - thank you to anyone who helps fund this effort! -### 1. Fork this repository +- [DoFollow](https://dofollow.co.uk/) +- [Varna Sri Raman](https://about.me/varna) -(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. +**[Become a sponsor for Beautiful Jekyll and unlock new features\!](https://github.com/sponsors/daattali/sponsorships?tier_id=39856)** -### 2. Rename the repository to `.github.io` +# Build your website in 3 steps -This will create a GitHub User page ready with the **Beautiful Jekyll** template that will be available at `http://.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. +There are a few different ways to build a website using Beautiful Jekyll, and this document will go through the simplest one: using a fork on GitHub. For most people (including myself!), this easy method is the recommended one. +Even if you choose to use one of the [advanced installation methods](https://beautifuljekyll.com/getstarted/#install-steps-hard), I still suggest you read through the easy method first. + +## 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 30-second video just as a reference as you work through the steps. If you don't already have a [GitHub account](https://github.com), you'll need to sign up. + +![Installation steps](https://beautifuljekyll.com/assets/img/install-steps.gif) + +### 1. Fork this project + +Click on the __*Fork*__ button at the top right corner of this page. Forking means that you're copying this entire project and all its files into your account. Do not click on the __*Create fork*__ button on the next page yet. + +### 2. Rename the repository to `YOURUSERNAME.github.io` + +You'll see the word "repository" used a lot in GitHub - it simply means "project". Under __*Repository name*__ you should see the name `beautiful-jekyll`, this is where you need to rename your project to `YOURUSERNAME.github.io` (replace `YOURUSERNAME` with your GitHub user name). It's important to use this exact name so that GitHub will recognize it and automatically create a website for this project. + +> Tip: If you want to use a different URL for your website, check out the [FAQ](https://beautifuljekyll.com/faq/#custom-domain) + ### 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, first click on it to view the file, and on the next page 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 there are 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. After changing the settings, click the green __*Commit changes*__ button to save these edits. + +> Note: In the video above, only one setting in the `_config.yml` file is edited, but you should go through the rest of the settings as well. + +### 4. Congratulations! You have a website! -Another way to edit the config file (or any other file) is to use [prose.io](http://prose.io/), which is just a simple interface to allow you to more intuitively edit files or add new files to your project. +If you named your project correctly and made an edit to the config file, your website should be ready in a minute or two at `https://YOURUSERNAME.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. -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 `http://.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. +## The harder way (for advanced users) -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 `http://.github.io` (replace `` with your user name). Do not add `www` to the URL - it will not work! +The instructions above explain how to use Beautiful Jekyll in the easiest way: by forking on GitHub. There are more [advanced installation methods](https://beautifuljekyll.com/getstarted/#install-steps-hard) that include either using GitHub Pages with remote themes, or using Ruby gems. They provide you with more control, but are only intended for advanced users. -**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 :)** +> Note: Beautiful Jekyll was primarily designed to be used as a GitHub theme, so you will not get any support if you use this theme via Ruby gems. -### Add your own content +# Plans -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](http://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! +Beautiful Jekyll is, and always will be, free. But if you want to remove the Beautiful Jekyll ad from your website, use a Dark Mode skin, access office hours, or simply support the development efforts, [check out the different plans](https://beautifuljekyll.com/plans). -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 that's the recommended approach ([here's a great tutorial](https://markdowntutorial.com/) if you need to learn markdown in 5 minutes). -As mentioned previously, you can use [prose.io](http://prose.io/) to add or edit files instead of doing it directly on GitHub, it can be a little easier that way. +To see an example of a markdown file, click on any file that ends in `.md`, for example [`aboutme.md`](./aboutme.md). On that 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. + +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**: -In order to have your new pages use this template and not just be plain pages, you need to add [YAML front matter](http://jekyllrb.com/docs/frontmatter/) 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: ``` --- --- ``` -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: +This is where you'll be able to give each page some extra parameters (such as a title, a subtitle, an image, etc - [below is a list of all parameters](#supported-parameters)). Add any parameters you want between these two dashed lines, for example: ``` --- @@ -82,144 +124,116 @@ 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. - -**Important takeaway: ALWAYS add the YAML front matter to EVERY page, which is two lines with three dashes. 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. - -## Basic Features - -#### 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. - -#### Personalization - -Many personalization settings in `_config.yml`, such as setting your name and site's description, 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. - -#### Allowing users to leave comments - -If you want to enable comments on your site, Beautiful Jekyll supports the [Disqus](https://disqus.com/) comments plugin. To use it, simply sign up to Disqus and add your Disqus shortname to the `disqus` parameter in the `_config.yml`. +If you don't want to use any parameters on a page, you still need to use the two dashed lines. If you don't, then your file will be shown as-is without the Beautiful Jekyll template. -If the `disqus` parameter is 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. +You can look at the top of [`aboutme.md`](https://raw.githubusercontent.com/daattali/beautiful-jekyll/master/aboutme.md) as an example. -#### Adding Google Analytics to track page views +**Important takeaway: ALWAYS add the YAML front matter, which is two lines of three dashes, to EVERY page. If you have any parameters, they go between the two lines.** -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](http://www.google.com/analytics/) to obtain your Google Tracking ID, and add this tracking ID to the `google_analytics` parameter in `_config.yml`. +# Supported parameters -#### Sharing blog posts on social media +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 site-wide settings. If there's a parameter that you want to apply to the entire site instead of one specific page, check out [this FAQ answer](https://beautifuljekyll.com/faq/#default-params). -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. +## Main parameters -#### 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 -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](http://deanattali.com/) as an example). -comments | If you want do add Disqus 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 set your Disqus id in the `_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`. -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). -layout | What type of page this is (default is `blog` 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`) -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`) -css | List of local CSS files to include in the page -ex-css | List of external CSS files to include in the page -googlefonts | List of Google fonts to include in the page (eg. `["Monoton", "Lobster"]`) +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 you must use the list notation (use `[]` even if you have only one image), and each image should be provided as `"/path/to/img" : "Caption of image"`. +thumbnail-img | For blog posts, if you want to add a thumbnail that will show up 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. +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, giscus, CommentBox) 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`. +mathjax | If you want to use LaTeX formulas, you need to enable MathJax. Note that in MathJax you need to use `$$` and `\\(` to start and end expressions -### RSS feed +## Parameters for SEO and social media sharing -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`. +These parameters let you control what information shows up when a page is shown in a search engine (such as Google) or gets shared on social media (such as Twitter/Facebook). -### GitHub Project page vs user page +Parameter | Description +----------- | ----------- +share-title | A title for the page. If not provided, then `title` will be used, and if that's missing then the site title (from `_config.yml`) is used. +share-description | A brief description of the page. If not provided, then `subtitle` will be used, and if that's missing then an excerpt from the page content is used. +share-img | The image to show. If not provided, then `cover-img` or `thumbnail-img` will be used if one of them is provided. -If you're not sure what the difference is, then ignore this section. +## Less commonly used parameters -If you want to use this theme for a project page for a specific repository instead of your main GitHub user page, that's no problem. The demo for this site ([daattali.github.io/beautiful-jekyll](http://deanattali.com/beautiful-jekyll)) is actually set up as a project page while my personal site ([daattali.github.io](http://deanattali.com)) is a regular user page. The only difference is that in the `_config.yml`, you should set `baseurl` to be `/projectname` instead of `""`. +These are parameters that you may not use often, but can come in handy sometimes. -To set up a GitHub Project page, simply fork this repository into a branch called `gh-pages` in your repository. Whatever is under the `gh-pages` branch will be served by Jekyll. Your site will be at `http://username.github.io/projectname/`. +Parameter | Description +----------- | ----------- +author | Specify the author of a blog post (useful if a website has multiple authors). +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`. +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. +last-updated | If you want to show that a blog post was updated after it was originally released, you can specify an "Updated on" date. +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. -### Advanced features (including how to use a custom URL address for your site) +Parameter | Description +----------- | ----------- +footer-extra | If you want to include extra content below the social media icons 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`). Accepts a single file or a list of files. +before-content | Similar to `footer-extra`, but used for including HTML before the main content of the page (below the title). +after-content | Similar to `footer-extra`, but used for including HTML after the main content of the page (above the footer). +head-extra | Similar to `footer-extra`, but used if you have any HTML code that needs to be included in the `` tag of the page. +language | HTML language code to be set on the page's <html> element. +full-width | By default, page content is constrained to a standard width. Use `full-width: true` to allow the content to span the entire width of the window. +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. -I wrote [a blog post](http://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. +## Page types -### Featured users (success stories!) +- **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! -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. +# Featured users (success stories!) -Want your website featured here? [Contact me](http://deanattali.com/aboutme#contact) to let me know about your website. +Visit the [Official website](http://beautifuljekyll.com/examples) to see sample websites using Beautiful Jekyll. -#### Project/company websites +If you'd like to showcase yourself and join this list, [upgrading to the Individual plan](https://github.com/sponsors/daattali/sponsorships?&tier_id=7362) will give you that publicity plus some other rewards! -| Website | Description | -| :------ |:----------- | -| [teampass.net](http://teampass.net) | Collaborative Passwords Manager | -| [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 | -| [embedded.guide](http://embedded.guide) | Writing an Embedded OS | -| [blabel.github.io](http://blabel.github.io) | Library for canonicalising blank node labels in RDF graphs | -| [reactionic.github.io](http://reactionic.github.io) | Create iOS and Android apps with React and Ionic | -| [ja2-stracciatella.github.io](http://ja2-stracciatella.github.io) | Jagged Alliance 2 Stracciatella | -| [PatientOutcomeFunding.org](http://www.patientoutcomefunding.org/) | Patient Outcome Funding | +# Next steps -#### Personal websites +Congratulations on making it this far! You now have all the tools to easily build a beautiful website for free. -| Website | Who | What | -| :------ |:--- | :--- | -| [deanattali.com](http://deanattali.com) | Dean Attali | Creator of Beautiful Jekyll | -| [ouzor.github.io](http://ouzor.github.io) | Juuso Parkkinen | Data scientist | -| [derekogle.com](http://derekogle.com/) | Derek Ogle | Professor of Mathematical Sciences and Natural Resources | -| [trappmartin.github.io](http://trappmartin.github.io) | Martin Trapp | Machine learning researcher | -| [melyanna.github.io](http://melyanna.github.io/) | Melyanna | Shows off her nice art | -| [chauff.github.io](http://chauff.github.io/) | Claudia Hauff | Professor at Delft University of Technology | -| [kootenpv.github.io](http://kootenpv.github.io/) | Pascal van Kooten | Data analytics | -| [sjackman.ca](http://sjackman.ca) | Shaun Jackman | PhD candidate in bioinformatics | -| [epwalsh.com](https://epwalsh.com) | Evan Pete Walsh | PhD candidate (Statistics and Mathematics) at Iowa State University | -| [otomatikmuhendis.com](http://otomatikmuhendis.com/) | Olcay Bayram | Software engineer | +- After you get comfortable with the basics of writing in markdown, I suggest taking a look at this [sample post](https://beautifuljekyll.com/2020-02-28-sample-markdown/) and [the code that created it](https://raw.githubusercontent.com/daattali/beautiful-jekyll/master/_posts/2020-02-28-sample-markdown.md) to learn some more advanced tips about markdown. -### Very advanced: Local development +- I **highly recommend** going over the [*Frequently Asked Questions*](https://beautifuljekyll.com/faq/) to find out answers to questions you may not even know you have. Every few months I suggest checking the [*What's New?*](https://beautifuljekyll.com/updates/) page to see if there are new features, and learn [how to update your site to the newest version](https://beautifuljekyll.com/faq/#updating) when it's time. -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 to do that with Vagrant: +- You can also check out the [advanced installation methods](https://beautifuljekyll.com/getstarted/#install-steps-hard) that give you a little more control but are harder to use. Keep in mind that Beautiful Jekyll was primarily designed to be used as a GitHub theme, so you will not get any support if you choose one of the Ruby installation methods. -1. Install [VirtualBox](http://virtualbox.org) and [Vagrant](https://www.vagrantup.com) -2. Clone your fork `git clone git@github.com:yourusername/yourusername.github.io.git` -3. Inside your repository folder, run `vagrant up` -4. View your website at `http://0.0.0.0:4000` on *nix or `http://127.0.0.1:4000` on Windows. -5. Commit any changes and push everything to the master branch of your GitHub repository. GitHub Pages will then rebuild and serve your website automatically. +- Remember that Beautiful Jekyll is built on top of Jekyll. This means that reading through the [Jekyll documentation](https://jekyllrb.com/) will introduce you to many more features that you might find useful! -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! +# Getting help -Additionally, if you choose to deploy Jekyll using a local ruby installation, you can tell Jekyll to automatically categorize your blog posts by tags. You just need to set `link-tags: true` in `_config.yml`. Jekyll will then generate a new page for each unique tag which lists all of the posts that belong to that tag. +Visit the [FAQ page](https://beautifuljekyll.com/faq) for answers to commonly asked questions. -### Credits +**If you choose to [become a sponsor](https://beautifuljekyll.com/plans/), you'll have access to my [office hours](https://beautifuljekyll.com/officehours/) where you can ask for help.** You can also use the [Discussions](https://github.com/daattali/beautiful-jekyll/discussions) area to try and get help from the community. -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. +Beautiful Jekyll is used by 50,000+ people with wildly varying degrees of web skills, so it's impossible to answer all the questions that may arise. For any question that's not specifically related to Beautiful Jekyll and is more about Jekyll or web development in general, the answer can often be found on Google, in the [Jekyll documentation](https://jekyllrb.com/), or on the [Jekyll support forum](https://talk.jekyllrb.com/). -I'd also like to thank [Dr. Jekyll's Themes](http://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 -### Contributions +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. -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! +You can also contribute by becoming an [official sponsor](https://github.com/sponsors/daattali/sponsorships?tier_id=39856) to help keep Beautiful Jekyll well-maintained! -Thank you to [all contributors](https://github.com/daattali/beautiful-jekyll/graphs/contributors). Special thanks to the following people with non-trivial contributions (in chronological order): [@hristoyankov](https://github.com/hristoyankov), [@jamesonzimmer](https://github.com/jamesonzimmer), [@XNerv](https://github.com/XNerv), [@epwalsh](https://github.com/epwalsh), [@rtlee9](https://github.com/rtlee9). +# Credits -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 :) +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. -### Known limitations +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. -- 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. diff --git a/Vagrantfile b/Vagrantfile deleted file mode 100644 index 768f2a443ce1..000000000000 --- a/Vagrantfile +++ /dev/null @@ -1,48 +0,0 @@ -# -*- mode: ruby -*- -# vi: set ft=ruby : - -$script_provision = < + +{% endif %} diff --git a/_includes/commentbox.html b/_includes/commentbox.html new file mode 100644 index 000000000000..e8019dadef62 --- /dev/null +++ b/_includes/commentbox.html @@ -0,0 +1,7 @@ +{% if site.commentbox %} + +
+ + + +{% endif %} diff --git a/_includes/comments.html b/_includes/comments.html new file mode 100644 index 000000000000..66242332a143 --- /dev/null +++ b/_includes/comments.html @@ -0,0 +1,8 @@ +{% if page.comments %} + {% include disqus.html %} + {% include fb-comment.html %} + {% include staticman-comments.html %} + {% include utterances-comment.html %} + {% include giscus-comment.html %} + {% include commentbox.html %} +{% endif %} diff --git a/_includes/disqus.html b/_includes/disqus.html index fd05ba0c4395..d1c5575eaf72 100644 --- a/_includes/disqus.html +++ b/_includes/disqus.html @@ -1,17 +1,19 @@ -{% if site.disqus %} -
-
- - +{%- if site.disqus -%} +
+
+
+ + +
-{% endif %} +{%- endif -%} diff --git a/_includes/ext-css.html b/_includes/ext-css.html new file mode 100644 index 000000000000..c177a7c8d25d --- /dev/null +++ b/_includes/ext-css.html @@ -0,0 +1,7 @@ +{% if include.css.sri %} + +{% elsif include.css.href %} + +{% else %} + +{% endif %} diff --git a/_includes/ext-js.html b/_includes/ext-js.html new file mode 100644 index 000000000000..3738ef2c1455 --- /dev/null +++ b/_includes/ext-js.html @@ -0,0 +1,7 @@ +{% if include.js.sri %} + +{% elsif include.js.href %} + +{% else %} + +{% endif %} diff --git a/_includes/fb-comment.html b/_includes/fb-comment.html new file mode 100644 index 000000000000..d29682cac580 --- /dev/null +++ b/_includes/fb-comment.html @@ -0,0 +1,16 @@ +{%- if site.fb_comment_id -%} +
+
+ +
+ +
+{%- endif -%} diff --git a/_includes/footer-minimal.html b/_includes/footer-minimal.html index d8d3b4195f6c..66b295a71db4 100644 --- a/_includes/footer-minimal.html +++ b/_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 }} - {% endif %} +   •   + {{ site.url-pretty }} + {% endif %}
-
\ No newline at end of file + diff --git a/_includes/footer-scripts.html b/_includes/footer-scripts.html index 8c578573ea08..bca6aede133f 100644 --- a/_includes/footer-scripts.html +++ b/_includes/footer-scripts.html @@ -1,18 +1,6 @@ {% if layout.common-ext-js %} {% for js in layout.common-ext-js %} - - {% endfor %} -{% endif %} - -{% if page.ext-js %} - {% for js in page.ext-js %} - - {% endfor %} -{% endif %} - -{% if page.js %} - {% for js in page.js %} - + {% include ext-js.html js=js %} {% endfor %} {% endif %} @@ -21,14 +9,30 @@ {% if js contains 'jquery' %} {% else %} - + {% endif %} {% endfor %} {% endif %} -{% include google_analytics.html %} +{% if site.site-js %} + {% for js in site.site-js %} + + {% endfor %} +{% endif %} + +{% if page.ext-js %} + {% for js in page.ext-js %} + {% include ext-js.html js=js %} + {% endfor %} +{% endif %} + +{% if page.js %} + {% for js in page.js %} + + {% endfor %} +{% endif %} diff --git a/_includes/footer.html b/_includes/footer.html index 50f245bca04f..9bfaf547a326 100644 --- a/_includes/footer.html +++ b/_includes/footer.html @@ -1,154 +1,46 @@