fix documentation for latest features

This commit is contained in:
Dean Attali 2020-08-08 06:09:00 +00:00
parent ac04e14954
commit 332a3adaa2
4 changed files with 17 additions and 16 deletions

View File

@ -1,10 +1,10 @@
## Unreleased version ## Unreleased version
- Adds configuration for page text color. (#694) - Add `text-col `config setting for main text color (#694)
- Adds support for site level keywords page meta header. (#691) - Add `keywords` config setting to set the meta keywords on all pages (for SEO purposes) (#691)
- Adds support for custom meta-theme site color. (#692) - Add `mobile-theme-col` config setting to allow a mobile theme colour (#692)
- Add support for `site-css` config parameter to provide site-level CSS files. (#695) - Add `site-css` config setting in the config file to provide CSS files that are used on all pages in the site (#695)
- Add support for `description` YAML parameter to provide a more detailed meta description (#690) - Add YAML option `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 ## v4.0.1 2020-07-13
@ -138,3 +138,4 @@
... Many small changes because the site was in its infancy ... Many small changes because the site was in its infancy
**2015-03-12** Beautiful Jekyll version 0.0000001 is released! **2015-03-12** Beautiful Jekyll version 0.0000001 is released!

View File

@ -150,7 +150,7 @@ nav-short | By default, the navigation bar gets shorter after scrolling down t
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-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. 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. 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.
description | A longer description of page or blog post that is used for your meta description content. description | A brief description of the page (used in search engines and when the page is shared).
## Advanced parameters ## Advanced parameters
@ -262,3 +262,4 @@ I'd also like to thank [Dr. Jekyll's Themes](https://drjekyllthemes.github.io/),
# Known limitations # Known limitations
- 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. - 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.

View File

@ -80,12 +80,12 @@ link-tags: true
# Excerpt Word Length - Truncates the excerpt to the specified number of words on the index page # Excerpt Word Length - Truncates the excerpt to the specified number of words on the index page
excerpt_length: 50 excerpt_length: 50
# Sets the search engine keywords for pages on your site # The keywords to associate with your website, for SEO purposes
#keywords: "my,list,of,keywords" #keywords: "my,list,of,keywords"
# --- Colours / background image --- # # --- Colours / background image --- #
# Personalize the colors in your website. Colour values can be any valid CSS colour # Personalize the colours in your website. Colour values can be any valid CSS colour
navbar-col: "#F5F5F5" navbar-col: "#F5F5F5"
navbar-text-col: "#404040" navbar-text-col: "#404040"
@ -105,14 +105,12 @@ footer-link-col: "#404040"
#footer-img: "/assets/img/bgimage.png" #footer-img: "/assets/img/bgimage.png"
#page-img: "/assets/img/bgimage.png" #page-img: "/assets/img/bgimage.png"
# Customize the site coloration for your website. This is used by various applications, # Suggest a colour for mobile browsers to use as the browser's theme. This is only supported by a few mobile browsers.
# for example many mobile browsers will use this color in their user interface elements #mobile-theme-col: "#0085A1"
# when users view your website.
#custom-site-color: ""
# You can also include any number of additional CSS assets in every page on your site # For any extra customization, you can include additional CSS files in every page on your site
#site-css: #site-css:
# - "/assets/css/my-style.css" # - "/assets/css/custom-styles.css"
# --- Web Statistics Section --- # # --- Web Statistics Section --- #
@ -225,3 +223,4 @@ plugins:
# Beautiful Jekyll / Dean Attali # Beautiful Jekyll / Dean Attali
# 2fc73a3a967e97599c9763d05e564189 # 2fc73a3a967e97599c9763d05e564189

View File

@ -14,8 +14,8 @@
<meta name="description" content="{{ page.subtitle }}"> <meta name="description" content="{{ page.subtitle }}">
{% endif %} {% endif %}
{% if site.custom-site-color %} {% if site.mobile-theme-col %}
<meta name="theme-color" content="{{ site.custom-site-color }}"> <meta name="theme-color" content="{{ site.mobile-theme-col }}">
{% endif %} {% endif %}
{% if site.keywords %} {% if site.keywords %}