diff --git a/README.md b/README.md index 7debb8a..5d2e566 100644 --- a/README.md +++ b/README.md @@ -64,7 +64,18 @@ Basically Basic is a [Jekyll theme](https://jekyllrb.com/docs/themes/) meant as ## 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 diff --git a/_includes/masthead.html b/_includes/masthead.html index 8a5b70e..13954b9 100644 --- a/_includes/masthead.html +++ b/_includes/masthead.html @@ -1,7 +1,7 @@ -{% if site.image contains '://' %} - {% assign site_image = site.image %} +{% if site.logo contains '://' %} + {% assign site_logo = site.logo %} {% else %} - {% assign site_image = site.image | relative_url %} + {% assign site_logo = site.logo | relative_url %} {% endif %}
@@ -10,18 +10,18 @@ {% if page.url == '/' %}

- {% if site.image %}{% endif %} + {% if site.logo %}{% endif %} {{ site.title | escape }}

{% else %}

- {% if site.image %}{% endif %} + {% if site.logo %}{% endif %} {{ site.title | escape }}

{% endif %} -
\ No newline at end of file + diff --git a/_sass/basically-basic/_global.scss b/_sass/basically-basic/_global.scss index 7749ec4..abb3f50 100644 --- a/_sass/basically-basic/_global.scss +++ b/_sass/basically-basic/_global.scss @@ -28,7 +28,7 @@ } } -.site-image { +.site-logo { width: $site-image-width; height: $site-image-height; margin-right: 0.5rem; diff --git a/example/_config.yml b/example/_config.yml index 41ac295..4ead118 100644 --- a/example/_config.yml +++ b/example/_config.yml @@ -25,7 +25,7 @@ author: picture: https://api.adorable.io/avatars/285/johndoe.png twitter_username: Towlette_Pettetucci github_username: Towlette_Pettetucci -image: /assets/images/100x100.png # ~100x100px +logo: /assets/images/100x100.png # ~100x100px # Build settings markdown: kramdown