Skip to content

Commit

Permalink
rename no_description to hide_description
Browse files Browse the repository at this point in the history
  • Loading branch information
qwtel committed Nov 2, 2017
1 parent 5deef02 commit 9d32f8e
Show file tree
Hide file tree
Showing 6 changed files with 9 additions and 7 deletions.
6 changes: 4 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ Nov 2 2017
{:.heading.post-date}

### Changed
* Renamed `no_description` to `hide_description`.
Since this feature isn't yet documented outside of the change log, the old name *will not* continue to work.
* When providing images to `image`, `image.path`, `image.src`, `image.srcset` and `accent_image `,
it is no longer necessary to prepend the url with the `baseurl` of the site,
e.g. values like `accent_image: /assets/img/sidebar-bg.jpg` are now valid.
Expand Down Expand Up @@ -235,7 +237,7 @@ That being said, you should be aware of these (small) breaking changes:
* Added an error page that is shown when client-side network errors occur. It contains a link to retry loading the page.
Previously, the browser's default error page would have been shown.

* Added `no_description` option to pages to prevent the content of `description` fields to show up in the output.
* Added `hide_description` option to pages to prevent the content of `description` fields to show up in the output.
This allows you to use the `description` field in the front matter to set descriptions for search engines and sharing on social media,
without having to worry about the output.

Expand All @@ -246,7 +248,7 @@ That being said, you should be aware of these (small) breaking changes:
- scope:
path: ''
values:
no_description: true
hide_description: true
```

* Added a new option called `no_inline_css`.
Expand Down
2 changes: 1 addition & 1 deletion _includes/post.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ <h1 class="post-title">
{% include tag-list.html tags=post.tags meta=site.featured_tags start_with=tag_start separator=tag_separator %}
</p>

{% include message.html text=post.description hide=page.no_description %}
{% include message.html text=post.description hide=page.hide_description %}
</header>

{% unless include.excerpt %}
Expand Down
2 changes: 1 addition & 1 deletion _layouts/about.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ <h1 class="page-title hr">{{ page.title }}</h1>

{{ author.about | markdownify }}

{% include message.html text=page.description hide=page.no_description alt="" %}
{% include message.html text=page.description hide=page.hide_description alt="" %}

{{ content }}
</article>
2 changes: 1 addition & 1 deletion _layouts/default.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<article class="page" role="article">
<header>
<h1 class="page-title">{{ page.title | default:strings.home | default:"Home" }}</h1>
{% include message.html text=page.description hide=page.no_description %}
{% include message.html text=page.description hide=page.hide_description %}
</header>

{{ content }}
Expand Down
2 changes: 1 addition & 1 deletion _layouts/list.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
{% if page.title.size > 0 %}
<header>
<h1 class="page-title">{{ page.title }}</h1>
{% include message.html text=page.description hide=page.no_description %}
{% include message.html text=page.description hide=page.hide_description %}
</header>
<hr class="sr-only"/>
{% endif %}
Expand Down
2 changes: 1 addition & 1 deletion _layouts/page.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<article class="page" role="article">
<header>
<h1 class="page-title">{{ page.title }}</h1>
{% include message.html text=page.description hide=page.no_description %}
{% include message.html text=page.description hide=page.hide_description %}
</header>

{{ content }}
Expand Down

0 comments on commit 9d32f8e

Please sign in to comment.