Rename `site.image` to `site.logo` for parity with jekyll-seo-tag plugin

- Describe site-wide elements in _config.yml
This commit is contained in:
Michael Rose 2017-03-19 12:27:58 -04:00
parent 4d8b9c832d
commit 42739b5eed
4 changed files with 20 additions and 9 deletions

View File

@ -64,7 +64,18 @@ Basically Basic is a [Jekyll theme](https://jekyllrb.com/docs/themes/) meant as
## Configuration ## Configuration
Configuration of site-wide elements (`lang`, `title`, `description`, `image`, `author`, etc.) happens in your project's `_config.yml`. See the [example configuration](example/_config.yml) in this repo for reference. Configuration of site-wide elements (`lang`, `title`, `description`, `logo`, `author`, etc.) happens in your project's `_config.yml`. See the [example configuration](example/_config.yml) in this repo for additional reference.
| | Description |
| ------------------ | -------------------------------------------------------------------- |
| `lang` | Used to indicate the language of text (e.g., en-US, en-GB, fr) |
| `title` | Your site's title (e.g., Dungan's Awesome Site) |
| `description` | Short site description (e.g., A blog about grasshopper mash) |
| `url` | The full URL to your site (e.g., https://groverloaf.org) |
| `author` | Global author information (see below) |
| `logo` | Path to a site-wide logo (e.g., /assets/your-company-logo.png) |
| `twitter_username` | Site-wide Twitter username, used as a link in sidebar |
| `github_username` | Site-wide GitHub username, used as a link in sidebar |
### Skin ### Skin

View File

@ -1,7 +1,7 @@
{% if site.image contains '://' %} {% if site.logo contains '://' %}
{% assign site_image = site.image %} {% assign site_logo = site.logo %}
{% else %} {% else %}
{% assign site_image = site.image | relative_url %} {% assign site_logo = site.logo | relative_url %}
{% endif %} {% endif %}
<header id="masthead"> <header id="masthead">
@ -10,14 +10,14 @@
{% if page.url == '/' %} {% if page.url == '/' %}
<h1 class="site-title"> <h1 class="site-title">
<a href="{{ '/' | relative_url }}"> <a href="{{ '/' | relative_url }}">
{% if site.image %}<img src="{{ site_image }}" alt="" class="site-image">{% endif %} {% if site.logo %}<img src="{{ site_logo }}" alt="" class="site-logo">{% endif %}
<span>{{ site.title | escape }}</span> <span>{{ site.title | escape }}</span>
</a> </a>
</h1> </h1>
{% else %} {% else %}
<p class="site-title"> <p class="site-title">
<a href="{{ '/' | relative_url }}"> <a href="{{ '/' | relative_url }}">
{% if site.image %}<img src="{{ site_image }}" alt="" class="site-image">{% endif %} {% if site.logo %}<img src="{{ site_logo }}" alt="" class="site-logo">{% endif %}
<span>{{ site.title | escape }}</span> <span>{{ site.title | escape }}</span>
</a> </a>
</p> </p>

View File

@ -28,7 +28,7 @@
} }
} }
.site-image { .site-logo {
width: $site-image-width; width: $site-image-width;
height: $site-image-height; height: $site-image-height;
margin-right: 0.5rem; margin-right: 0.5rem;

View File

@ -25,7 +25,7 @@ author:
picture: https://api.adorable.io/avatars/285/johndoe.png picture: https://api.adorable.io/avatars/285/johndoe.png
twitter_username: Towlette_Pettetucci twitter_username: Towlette_Pettetucci
github_username: Towlette_Pettetucci github_username: Towlette_Pettetucci
image: /assets/images/100x100.png # ~100x100px logo: /assets/images/100x100.png # ~100x100px
# Build settings # Build settings
markdown: kramdown markdown: kramdown