New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

v2: Introduce show_overlay_excerpt and document #1436

Merged
merged 2 commits into from Jan 2, 2018

Conversation

Projects
None yet
2 participants
@dvhart
Contributor

dvhart commented Jan 1, 2018

These two patches introduce a new feature (#1429) allowing the per-page override of whether or not to display the excerpt in the overlay text, and document its usage.

v2:

  • Correct typo in documentat (test -> text)
  • Explicitly test for "!= false" to avoid changing default behavior
  • Remove _config.yml changes as they are no longer needed to maintain default behavior

dvhart added some commits Jan 1, 2018

Make excerpts optional in header overlay
Some posts and some header images don't lend themselves well to
displaying the excerpt in the overlay. Make this optional by
introducting a new boolean variable:

page.header.show_overlay_excerpt

Set it to implicitly default to true so existing users are unaffected by
testing explicitly for "!= false".

This can be enabled globally for a site by changing the default to false
in the local _config.yml, or per page by specifying the value in front
matter.

Signed-off-by: Darren Hart <darren@dvhart.com>
Document show_overlay_excerpt variable
Add show_overlay_excerpt variable to the Header Overlay field
documentation table.

Signed-off-by: Darren Hart <darren@dvhart.com>
@mmistakes

This comment has been minimized.

Show comment
Hide comment
@mmistakes

mmistakes Jan 2, 2018

Owner

This looks good @dvhart! Thanks for making the changes and pushing this through.

Owner

mmistakes commented Jan 2, 2018

This looks good @dvhart! Thanks for making the changes and pushing this through.

@mmistakes mmistakes merged commit 7bf2b58 into mmistakes:master Jan 2, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment