From 4fa9fc8ad488ce0bd039baa1885e1ecb01f1dfe1 Mon Sep 17 00:00:00 2001 From: Gabriel Date: Sun, 26 Apr 2020 20:31:05 +0200 Subject: [PATCH] Make theme compatible with remote_theme (#590); fixes #339 --- 404.html | 2 +- README.md | 15 ++++++++++++++- _config.yml | 13 ++++++------- _layouts/base.html | 12 ++++++------ _layouts/minimal.html | 8 ++++---- _posts/2015-01-04-first-post.md | 2 +- _posts/2015-02-26-flake-it-till-you-make-it.md | 2 +- {css => assets/css}/bootstrap-social.css | 0 {css => assets/css}/bootstrap-theme.css | 0 {css => assets/css}/bootstrap-theme.css.map | 0 {css => assets/css}/bootstrap-theme.min.css | 0 {css => assets/css}/bootstrap.css | 0 {css => assets/css}/bootstrap.css.map | 0 {css => assets/css}/bootstrap.min.css | 0 {css => assets/css}/main-minimal.css | 0 {css => assets/css}/main.css | 0 {css => assets/css}/normalize.css | 0 {css => assets/css}/pygment_highlights.css | 0 {css => assets/css}/staticman.css | 0 {img => assets/img}/404-southpark.jpg | Bin {img => assets/img}/avatar-icon.png | Bin {img => assets/img}/bgimage.png | Bin {img => assets/img}/hello_world.jpeg | Bin {img => assets/img}/install-steps.gif | Bin {img => assets/img}/path.jpg | Bin {js => assets/js}/bootstrap.js | 0 {js => assets/js}/bootstrap.min.js | 0 {js => assets/js}/jquery-1.11.2.min.js | 0 {js => assets/js}/main.js | 0 {js => assets/js}/staticman.js | 0 30 files changed, 33 insertions(+), 21 deletions(-) rename {css => assets/css}/bootstrap-social.css (100%) rename {css => assets/css}/bootstrap-theme.css (100%) rename {css => assets/css}/bootstrap-theme.css.map (100%) rename {css => assets/css}/bootstrap-theme.min.css (100%) rename {css => assets/css}/bootstrap.css (100%) rename {css => assets/css}/bootstrap.css.map (100%) rename {css => assets/css}/bootstrap.min.css (100%) rename {css => assets/css}/main-minimal.css (100%) rename {css => assets/css}/main.css (100%) rename {css => assets/css}/normalize.css (100%) rename {css => assets/css}/pygment_highlights.css (100%) rename {css => assets/css}/staticman.css (100%) rename {img => assets/img}/404-southpark.jpg (100%) rename {img => assets/img}/avatar-icon.png (100%) rename {img => assets/img}/bgimage.png (100%) rename {img => assets/img}/hello_world.jpeg (100%) rename {img => assets/img}/install-steps.gif (100%) rename {img => assets/img}/path.jpg (100%) rename {js => assets/js}/bootstrap.js (100%) rename {js => assets/js}/bootstrap.min.js (100%) rename {js => assets/js}/jquery-1.11.2.min.js (100%) rename {js => assets/js}/main.js (100%) rename {js => assets/js}/staticman.js (100%) diff --git a/404.html b/404.html index 432a7a2..340fe9e 100644 --- a/404.html +++ b/404.html @@ -9,5 +9,5 @@ permalink: /404.html

Move along. (404 error)


- + diff --git a/README.md b/README.md index 662bcec..8336d36 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ 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) +![Installation steps](assets/img/install-steps.gif) ### 0. Sign up to GitHub @@ -169,6 +169,19 @@ googlefonts | List of Google fonts to include in the page (eg. `["Monoton", "Lob 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. +### Use remote-theme (advanced) + +It is possible to use the `remote_theme` feature of GitHub pages. To do so, instead of forking this project: + +- Follow all the steps in https://guides.github.com/features/pages/ ***EXCEPT*** the ones where you chose the theme. +- add `remote_theme: daattali/beautiful-jekyll` to your `_config.yml` +- add `paginate: 5` (or any value you'd like) to your `_config.yml`. This is the only configuration value that is required. +- Optionally, if you want to use Staticman, you may need copy `_data/ui-text.yml` into your repo if you want to change the language. + + +Any folder or file that you don't include in your repository will be included by jekyll on build. If you want toreplace a file (css for instance), you'll just need to place it with the exact same path in own jekyll repo (e.g. `assets/css/main.css`) + + ### Advanced features (including how to use a custom URL address for your site) 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. diff --git a/_config.yml b/_config.yml index aa565f9..37b33b0 100644 --- a/_config.yml +++ b/_config.yml @@ -33,7 +33,7 @@ navbar-links: # Image to show in the navigation bar - works best with a square image # Remove this parameter if you don't want an image in the navbar -avatar: "/img/avatar-icon.png" +avatar: "/assets/img/avatar-icon.png" # By default, the image is cut into a circle. You can disable this behaviour here. round-avatar: true @@ -102,9 +102,9 @@ footer-link-col: "#404040" # 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" +#navbar-img: "/assets/img/bgimage.png" +#footer-img: "/assets/img/bgimage.png" +#page-img: "/assets/img/bgimage.png" # --- Web Statistics Section --- # @@ -134,6 +134,7 @@ footer-link-col: "#404040" #fb_comment_id: "" # To use Staticman comments, fill in "repository", "branch", and "endpoint" +# if using remote_theme, you will need to copy the _data/ui-text.yml to your repository 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` @@ -219,9 +220,7 @@ prose: - _config.yml - /_layouts - /_includes - - /css - - /img - - /js + - /assets metadata: _posts: - name: "layout" diff --git a/_layouts/base.html b/_layouts/base.html index 03695a9..0d7ab5b 100644 --- a/_layouts/base.html +++ b/_layouts/base.html @@ -1,17 +1,17 @@ --- common-css: - - "/css/bootstrap.min.css" - - "/css/bootstrap-social.css" - - "/css/main.css" + - "/assets/css/bootstrap.min.css" + - "/assets/css/bootstrap-social.css" + - "/assets/css/main.css" common-ext-css: - "//cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" common-googlefonts: - "Lora:400,700,400italic,700italic" - "Open+Sans:300italic,400italic,600italic,700italic,800italic,400,300,600,700,800" common-js: - - "/js/jquery-1.11.2.min.js" - - "/js/bootstrap.min.js" - - "/js/main.js" + - "/assets/js/jquery-1.11.2.min.js" + - "/assets/js/bootstrap.min.js" + - "/assets/js/main.js" --- diff --git a/_layouts/minimal.html b/_layouts/minimal.html index cdd90bd..95b8e2a 100644 --- a/_layouts/minimal.html +++ b/_layouts/minimal.html @@ -1,10 +1,10 @@ --- common-css: - - "/css/bootstrap.min.css" - - "/css/main-minimal.css" + - "/assets/css/bootstrap.min.css" + - "/assets/css/main-minimal.css" common-js: - - "/js/jquery-1.11.2.min.js" - - "/js/bootstrap.min.js" + - "/assets/js/jquery-1.11.2.min.js" + - "/assets/js/bootstrap.min.js" --- diff --git a/_posts/2015-01-04-first-post.md b/_posts/2015-01-04-first-post.md index 8c5b9d5..8c5cde8 100644 --- a/_posts/2015-01-04-first-post.md +++ b/_posts/2015-01-04-first-post.md @@ -1,7 +1,7 @@ --- layout: post title: First post! -image: /img/hello_world.jpeg +image: /assets/img/hello_world.jpeg --- This is my first post, how exciting! diff --git a/_posts/2015-02-26-flake-it-till-you-make-it.md b/_posts/2015-02-26-flake-it-till-you-make-it.md index fd5399f..4501112 100644 --- a/_posts/2015-02-26-flake-it-till-you-make-it.md +++ b/_posts/2015-02-26-flake-it-till-you-make-it.md @@ -2,7 +2,7 @@ layout: post title: Flake it till you make it subtitle: Excerpt from Soulshaping by Jeff Brown -bigimg: /img/path.jpg +bigimg: /assets/img/path.jpg tags: [books, test] --- diff --git a/css/bootstrap-social.css b/assets/css/bootstrap-social.css similarity index 100% rename from css/bootstrap-social.css rename to assets/css/bootstrap-social.css diff --git a/css/bootstrap-theme.css b/assets/css/bootstrap-theme.css similarity index 100% rename from css/bootstrap-theme.css rename to assets/css/bootstrap-theme.css diff --git a/css/bootstrap-theme.css.map b/assets/css/bootstrap-theme.css.map similarity index 100% rename from css/bootstrap-theme.css.map rename to assets/css/bootstrap-theme.css.map diff --git a/css/bootstrap-theme.min.css b/assets/css/bootstrap-theme.min.css similarity index 100% rename from css/bootstrap-theme.min.css rename to assets/css/bootstrap-theme.min.css diff --git a/css/bootstrap.css b/assets/css/bootstrap.css similarity index 100% rename from css/bootstrap.css rename to assets/css/bootstrap.css diff --git a/css/bootstrap.css.map b/assets/css/bootstrap.css.map similarity index 100% rename from css/bootstrap.css.map rename to assets/css/bootstrap.css.map diff --git a/css/bootstrap.min.css b/assets/css/bootstrap.min.css similarity index 100% rename from css/bootstrap.min.css rename to assets/css/bootstrap.min.css diff --git a/css/main-minimal.css b/assets/css/main-minimal.css similarity index 100% rename from css/main-minimal.css rename to assets/css/main-minimal.css diff --git a/css/main.css b/assets/css/main.css similarity index 100% rename from css/main.css rename to assets/css/main.css diff --git a/css/normalize.css b/assets/css/normalize.css similarity index 100% rename from css/normalize.css rename to assets/css/normalize.css diff --git a/css/pygment_highlights.css b/assets/css/pygment_highlights.css similarity index 100% rename from css/pygment_highlights.css rename to assets/css/pygment_highlights.css diff --git a/css/staticman.css b/assets/css/staticman.css similarity index 100% rename from css/staticman.css rename to assets/css/staticman.css diff --git a/img/404-southpark.jpg b/assets/img/404-southpark.jpg similarity index 100% rename from img/404-southpark.jpg rename to assets/img/404-southpark.jpg diff --git a/img/avatar-icon.png b/assets/img/avatar-icon.png similarity index 100% rename from img/avatar-icon.png rename to assets/img/avatar-icon.png diff --git a/img/bgimage.png b/assets/img/bgimage.png similarity index 100% rename from img/bgimage.png rename to assets/img/bgimage.png diff --git a/img/hello_world.jpeg b/assets/img/hello_world.jpeg similarity index 100% rename from img/hello_world.jpeg rename to assets/img/hello_world.jpeg diff --git a/img/install-steps.gif b/assets/img/install-steps.gif similarity index 100% rename from img/install-steps.gif rename to assets/img/install-steps.gif diff --git a/img/path.jpg b/assets/img/path.jpg similarity index 100% rename from img/path.jpg rename to assets/img/path.jpg diff --git a/js/bootstrap.js b/assets/js/bootstrap.js similarity index 100% rename from js/bootstrap.js rename to assets/js/bootstrap.js diff --git a/js/bootstrap.min.js b/assets/js/bootstrap.min.js similarity index 100% rename from js/bootstrap.min.js rename to assets/js/bootstrap.min.js diff --git a/js/jquery-1.11.2.min.js b/assets/js/jquery-1.11.2.min.js similarity index 100% rename from js/jquery-1.11.2.min.js rename to assets/js/jquery-1.11.2.min.js diff --git a/js/main.js b/assets/js/main.js similarity index 100% rename from js/main.js rename to assets/js/main.js diff --git a/js/staticman.js b/assets/js/staticman.js similarity index 100% rename from js/staticman.js rename to assets/js/staticman.js