-
Notifications
You must be signed in to change notification settings - Fork 25
Document {{#social_accounts}} block helper #62
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
Open
ErisDS
wants to merge
2
commits into
main
Choose a base branch
from
docs/social-accounts-helper
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| --- | ||
| title: "social_accounts" | ||
| description: 'Usage: `{{#social_accounts @site}}{{/social_accounts}}`' | ||
| --- | ||
|
|
||
| *** | ||
|
|
||
| `{{#social_accounts}}` is a block helper that iterates over the connected social accounts on a given source object — usually `@site` or an author. The source must be passed as a positional argument. | ||
|
|
||
| ### Simple Example | ||
|
|
||
| Render a row of icons for the social accounts configured under Settings > General > Social accounts: | ||
|
|
||
| ```handlebars | ||
| {{#social_accounts @site}} | ||
| <a href="{{href}}" target="_blank" rel="noopener" aria-label="{{name}}"> | ||
| {{> (concat "icons/" type)}} | ||
| </a> | ||
| {{/social_accounts}} | ||
| ``` | ||
|
|
||
| ## Data Variables | ||
|
|
||
| When inside a `{{#social_accounts}}` block, the following properties are available for each account: | ||
|
|
||
| * **type** (string) - the platform key (e.g. `x`, `bluesky`) | ||
| * **href** (string) - the full URL to the profile | ||
| * **username** (string) - the raw stored handle or URL fragment | ||
| * **name** (string) - the human-readable platform label (e.g. `X`, `Facebook`) | ||
|
|
||
| The standard iteration variables are also available: | ||
|
|
||
| * **@index** (number) - the 0-based index of the current iteration | ||
| * **@number** (number) - the 1-based index of the current iteration | ||
| * **@first** (boolean) - true if this is the first iteration | ||
| * **@last** (boolean) - true if this is the last iteration | ||
| * **@odd** (boolean) - true if the @index is odd | ||
| * **@even** (boolean) - true if the @index is even | ||
|
|
||
| ## Usage | ||
|
|
||
| ### Per-author accounts | ||
|
|
||
| When used inside `{{#foreach authors}}`, pass `this` to iterate the current author’s accounts: | ||
|
|
||
| ```handlebars | ||
| {{#foreach authors}} | ||
| <h3>{{name}}</h3> | ||
| {{#social_accounts this}} | ||
| <a href="{{href}}" aria-label="{{name}}">{{> (concat "icons/" type)}}</a> | ||
| {{/social_accounts}} | ||
| {{/foreach}} | ||
| ``` | ||
|
|
||
| On an author page, the author is named `author`: | ||
|
|
||
| ```handlebars | ||
| {{#social_accounts author}} | ||
| <a href="{{href}}" aria-label="{{name}}">{{> (concat "icons/" type)}}</a> | ||
| {{/social_accounts}} | ||
| ``` | ||
|
|
||
| ### \{\{else}} and negation | ||
|
|
||
| Like all block helpers, `{{#social_accounts}}` supports an `{{else}}` block, which is executed when there are no connected accounts: | ||
|
|
||
| ```handlebars | ||
| {{#social_accounts @site}} | ||
| <a href="{{href}}">{{name}}</a> | ||
| {{else}} | ||
| <p>No social accounts connected yet.</p> | ||
| {{/social_accounts}} | ||
| ``` | ||
|
|
||
| ## Supported platforms | ||
|
|
||
| `x`, `facebook`, `linkedin`, `bluesky`, `threads`, `mastodon`, `tiktok`, `youtube`, `instagram`. Platforms without a value set on the source are skipped. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.