share

This is social media share button module for Hugo websites.

Table of Contents
Supported Social Media and Other Platforms
Requirements
Installation
Usage
Share Information Configuration
Other Configuration Properties

Email
Facebook
Facebook Messenger
Hatena
Instapaper
Line
LinkedIn
Live Journal
Mail.ru
Odnoklassniki
Pinterest
Pocket
Reddit
Telegram
Tumblr
Twitter
Viber
VK
Weibo
Whatsapp
Workplace

Requirements

Hugo v0.111.3
A Hugo site that has been initialized as a module.

This module was written with the above version of Hugo but it might be compatible with earlier versions.

Installation

In your Hugo config (toml), add this:

[module]
    [[module.imports]]
        path='github.com/koc-he/share'

Hugo will automatically download the module when your site is run or built.

In the <head> tag of your site, add this partial:

<head>
    <!-- Other things in your head tag -->
    {{partial "head/share-buttons-styling.html" . }}
</head>

Usage

Here is a basic example. All the buttons are enabled when no configuration is set.

To use all the buttons add this partial:

{{partial "utils/share-buttons/index.html" . }}

Shapes and Labels

The default shape is square, with no label.

To use the buttons in a round shape, set the variable round to true in the page’s scratch pad:

{{ .Scratch.Set "round" true }}
{{partial "utils/share-buttons/index.html" . }}

To use the buttons in a rectangular shape with labels, set the variable withLabel to true in the page’s scratch pad:

{{ .Scratch.Set "withLabel" true }}
{{partial "utils/share-buttons/index.html" . }}

Colors

The default button colors are the brand colors for each of the social media sites.

To specify matching colors for normal and active states, set these values in the page’s scratch pad (using .Scratch.Set).

background: the background color of the buttons in their normal state.
color: the text color of the buttons in their normal state.
activeBackground: the background color of the buttons in their active and hover state.
activeColor: the text color of the buttons in their active and hover state.

Here’s an example:

{{ .Scratch.Set "background" "#aab2ff" }}
{{ .Scratch.Set "color" "#112A46" }}
{{ .Scratch.Set "activeBackground" "#ffffff" }}
{{ .Scratch.Set "activeColor" "#000000" }}
{{ partial "utils/share-buttons/index.html" . }}

Enabling Specific Buttons

By default, all the buttons are shown.

To enable specific buttons, add their tag from the list shown below to the enabled slice variable to the page’s scratch pad.

email
facebook-messenger
facebook
hatena
instapaper
line
linkedin
live-journal
mail-ru
odnoklassniki
pinterest
pocket
reddit
telegram
tumblr
twitter
viber
vk
weibo
whatsapp
workplace

Here’s an example of how to set the enabled variable:

{{ .Scratch.Set "enabled" (slice "email" "twitter" "linkedin" "facebook" "reddit" "whatsapp" "pinterest") }}
{{ partial "utils/share-buttons/index.html" . }}

You can also chose to include individual button partials like this:

{{ partial "utils/share-buttons/linkedin.html" . }}

Just add any of the above tags where there is a placeholder here utils/share-buttons/[tag placeholder].html.

Resetting the Configuration

You can reset the configuration by calling this partial:

{{ partial "utils/share-buttons/helpers/reset.html" . }}

This table explains what is shared from your Hugo content. A lot of the values are picked up automatically.

In the Your Intervention column in the tables below, anything marked with:

🔧 requires your intervention. You need to set these values yourself.
✨ has been automatically set based on available Hugo site and page variables. It doesn’t require you to do anything.

1. Email

Platform Requirement	Hugo Equivalent	Your Intervention
`subject`	`.Title`	✨
`body`	`.Description` or `.Summary` with `.Permalink`	✨

2. Facebook Messenger

Platform Requirement	Hugo Equivalent	Your Intervention
`url`	`.Permalink`	✨
`app_id`	`.Site.Params.share.facebookMessenger.appId` (string)	🔧
`redirect_uri`	`.Params.share.facebookMessenger.redirectUri` (string)	🔧

Set the Facebook Messenger app ID in your site configuration (config.toml).

[params]
    [params.share]
        [params.share.facebookMessenger]
            appId = '12345678'

Set the Facebook Messenger redirect URI on your content pages in the frontmatter, if you’d like as shown below. If it is not set, this value defaults to .Permalink.

share:
    facebookMessenger:
        redirectUri: 'https://example.com'

3. Facebook

Platform Requirement	Hugo Equivalent	Your Intervention
`u`	`.Permalink`	✨
`quote`	`.Title`	✨
`hashtag`	`.Params.share.facebook.hashtag` (string)	🔧

Set the Facebook hashtag on your content pages in the frontmatter, if you’d like as shown below. If it is not set, this value defaults to an empty string.

share:
    facebook:
        hashtag: 'lorem'

Note that the hashtag is a single string and not a list.

4. Hatena

Platform Requirement	Hugo Equivalent	Your Intervention
`url`	`.Permalink`	✨
`title`	`.Title`	✨

5. Instapaper

Platform Requirement	Hugo Equivalent	Your Intervention
`url`	`.Permalink`	✨
`quote`	`.Title`	✨
`description`	first 40 characters of `.Description` or `.Summary`	✨

6. Line

Platform Requirement	Hugo Equivalent	Your Intervention
`url`	`.Permalink`	✨
`text`	`.Title`	✨

7. LinkedIn

Platform Requirement	Hugo Equivalent	Your Intervention
`url`	`.Permalink`	✨
`title`	`.Title`	✨
`summary`	first 40 characters of `.Description` or `.Summary`	✨
`source`	`.Site.BaseURL`	✨

8. Live Journal

Platform Requirement	Hugo Equivalent	Your Intervention
`url`	`.Permalink`	✨
`subject`	`.Title`	✨
`event`	first 40 characters of `.Description` or `.Summary`	✨

9. Mail.ru

Platform Requirement	Hugo Equivalent	Your Intervention
`url`	`.Permalink`	✨
`title`	`.Title`	✨
`description`	first 40 characters of `.Description` or `.Summary`	✨
`image_url`	first image of `.Params.images` (string, relative path)	🔧

Set the image url on your content pages in the frontmatter, if you’d like as shown below. If it is not set, this value defaults to an empty string. This is the same image used by the various SEO internal templates (OG, schema, and twitter cards).

images:
    - 'share.svg'

10. Odnoklassniki

Platform Requirement	Hugo Equivalent	Your Intervention
`url`	`.Permalink`	✨
`title`	`.Title`	✨
`description`	first 40 characters of `.Description` or `.Summary`	✨
`imageUrl`	first image of `.Params.images` (string, relative path)	🔧

images:
    - 'share.svg'

11. Pinterest

Platform Requirement	Hugo Equivalent	Your Intervention
`url`	`.Permalink`	✨
`description`	first 40 characters of `.Description` or `.Summary`	✨
`media`	first image of `.Params.images` (string, relative path)	🔧

images:
    - 'share.svg'

12. Pocket

Platform Requirement	Hugo Equivalent	Your Intervention
`url`	`.Permalink`	✨
`title`	`.Title`	✨

13. Reddit

Platform Requirement	Hugo Equivalent	Your Intervention
`url`	`.Permalink`	✨
`title`	`.Title`	✨

14. Telegram

Platform Requirement	Hugo Equivalent	Your Intervention
`url`	`.Permalink`	✨
`text`	`.Title`	✨

15. Tumblr

Platform Requirement	Hugo Equivalent	Your Intervention
`canonicalUrl`	`.Permalink`	✨
`title`	`.Title`	✨
`caption`	first 40 characters of `.Description` or `.Summary`	✨
`tags`	`.Params.share.tags` (string slice)	🔧

The tags you use on social media may be different from the tags you use for content organization on your website. So you have the option to set social media tags under .Params.share.tags.

The .tags are from Hugo’s built-in tags taxonomy. These are not considered.

Set the tags on your content pages in the frontmatter, if you’d like as shown below. If it is not set, this value defaults to an empty slice.

share:
    tags:
        - lorem
        - ipsum
        - dolor
        - sit
        - amet

16. Twitter

Platform Requirement	Hugo Equivalent	Your Intervention
`url`	`.Permalink`	✨
`text`	`.Title`	✨
`hashtags`	`.Params.share.tags` (string slice)	🔧
`via`	`.Site.Params.share.twitter.accountHandle` (string)	🔧
`related`	`.Site.Params.share.twitter.relatedAccounts` (string slice)	🔧

.Site.Params.share.twitter.accountHandle is the handle for your personal or organization Twitter account that you want associated with the tweet. This defaults to an empty string if not set. .Site.Params.share.twitter.relatedAccounts is a list of Twitter account handles that you wanted associated with the tweet. This defaults to an empty slice if not set. Set these values in your site config file, config.toml.

[params]
    [params.share]
        [params.share.twitter]
            accountHandle = 'twitterdev'
            relatedAccounts = ['twitter']

The tags you use on social media may be different from the tags you use for content organization on your website. So you have the option to set social media tags under .Params.share.tags.

The .tags are from Hugo’s built-in tags taxonomy. These are not considered.

Set the tags on your content pages in the frontmatter, if you’d like as shown below. If it is not set, this value defaults to an empty slice.

share:
    tags:
        - lorem
        - ipsum
        - dolor
        - sit
        - amet

17. Viber

Platform Requirement	Hugo Equivalent	Your Intervention
`text`	`.Title` and `.Permalink` separated by a space	✨

18. VK

Platform Requirement	Hugo Equivalent	Your Intervention
`url`	`.Permalink`	✨
`title`	`.Title`	✨
`noparse`	`.Site.Params.share.vk.noParse`	🔧
`no_vk_links`	`.Site.Params.share.vk.noVKLinks`	🔧
`image`	first image of `.Params.images` (string, relative path)	🔧

.Site.Params.share.vk.noParse when set to true tells VK servers not make an additional request to download missing information from the posted page. If false, the request is made.

.Site.Params.share.vk.noVKLinks when set to true indicates that there will be no active links to VK in the post window.

Set these values in your site config file, config.toml, as shown below.

[params]
    [params.share]
        [params.share.vk]
            noParse = true
            noVKLinks = true

images:
    - 'share.svg'

19. Weibo

Platform Requirement	Hugo Equivalent	Your Intervention
`url`	`.Permalink`	✨
`title`	`.Title`	✨
`imageUrl`	first image of `.Params.images` (string, relative path)	🔧

images:
    - 'share.svg'

20. Whatsapp

Platform Requirement	Hugo Equivalent	Your Intervention
`text`	`.Title` and `.Permalink` separated by a space	✨

21. Workplace

Platform Requirement	Hugo Equivalent	Your Intervention
`u`	`.Permalink`	✨
`quote`	`.Title`	✨
`hashtag`	`.Params.share.facebook.hashtag` (string)	🔧