@@ -86,9 +86,8 @@ Refers to snippets of code within the `_includes` directory that can be inserted
8686 - ` head.html ` &mdash ; Code-block that defines the ` <head></head> ` in * default* layout.
8787 - ` custom-head.html ` &mdash ; Placeholder to allow users to add more metadata to ` <head /> ` .
8888 - ` header.html ` &mdash ; Defines the site's main header section. By default, pages with a defined ` title ` attribute will have links displayed here.
89- - ` social.html ` &mdash ; Renders social-media icons based on the ` minima:social_links ` data in the config file.
90- - ` social-item.html ` &mdash ; Template to render individual list-item containing graphic link to configured social-profile.
91- - ` social-links/*.svg ` &mdash ; SVG markup components of supported social-icons.
89+ - ` social.html ` &mdash ; Renders social-media icons based on the ` minima:social_links ` data in the config file using
90+ the latest version of Font Awesome Free webfonts via remote CDN.
9291
9392
9493### Sass
@@ -283,67 +282,25 @@ Minima 2.x | Minima 3.0
283282
284283You can add links to the accounts you have on other sites, with respective icon as an SVG graphic, via the config file.
285284From `Minima-3.0` onwards, the social media data is sourced from config key `minima.social_links`. It is a list of key-value pairs, each entry
286- corresponding to a link rendered in the footer. For example, to render links to Jekyll GitHub repository and Twitter account, one should have :
285+ corresponding to a link rendered in the footer. For example, to render links to Jekyll GitHub repository and Twitter account (now X), one
286+ should have :
287287
288288` ` ` yaml
289289minima:
290290 social_links:
291- - { platform: github, user_url: "https://github.com/jekyll/jekyll" }
292- - { platform: twitter, user_url: "https://twitter.com/jekyllrb" }
291+ - title: Jekyll repository at GitHub
292+ icon: github
293+ url: "https://github.com/jekyll/jekyll"
294+ - title: Jekyll at X (formerly Twitter)
295+ icon: x-twitter
296+ url: "https://x.com/jekyllrb"
293297` ` `
294298
295- Apart from the necessary keys illustrated above, `title` may also be defined to render a custom link-title. By default, the title is the same
296- as `platform`. The `platform` key corresponds to the SVG id of the sprite in the composite file at URL `/assets/minima-social-icons.svg`.
297-
298- The theme ships with an icon for `rss` and icons of select social-media platforms :
299-
300- - ` bluesky`
301- - ` codeberg`
302- - ` devto`
303- - ` dribbble`
304- - ` facebook`
305- - ` flickr`
306- - ` github`
307- - ` gitlab`
308- - ` google_scholar`
309- - ` instagram`
310- - ` keybase`
311- - ` linkedin`
312- - ` mastodon`
313- - ` microdotblog`
314- - ` pinterest`
315- - ` stackoverflow`
316- - ` telegram`
317- - ` twitter`
318- - ` whatsapp`
319- - ` x`
320- - ` youtube`
321-
322- To render a link to a platform not listed above, one should first create a file at path `_includes/social-icons/<PLATFORM>.svg` comprised of
323- graphic markup **without the top-level `<svg></svg>`**. The icon is expected to be centered within a viewbox of `"0 0 16 16"`. Then, make an
324- entry under key `minima.social_links`.
325-
326- For example, to render a link to an account of user `john.doe` at platform `deviantart.com`, the steps to follow would be :
327- - Get DeviantArt logo in SVG format.
328- - Using a text-editor, open the downloaded file to inspect if the `viewBox` attribute is defined on the `<svg>` element and is set
329- as `"0 0 16 16" (or similar "square" dimension)`.
330- - If the `viewBox` attribute is non-square or undefined, the graphic *may optionally need* to be edited in a vector graphic editor such as
331- *Inkscape* or *Adobe Illustrator* for properly aligned render on page.
332- - Edit the SVG file in text-editor to delete everything **except** what is contained between `<svg></svg>` and save it into the Jekyll
333- project at path `_includes/social-icons/deviantart.svg`.
334- - Finally, edit the Jekyll config file to enable loading of new icon graphic with :
335- ` ` ` yaml
336- minima:
337- social_links:
338- - platform: deviantart # same as SVG filename.
339- user_url: "https://www.deviantart.com/john.doe" # URL of profile page.
340- title: My profile at DeviantArt.com # Optional. Text displayed on hovering over link.
341- ` ` `
342-
343- **Notes:**
344- - The list of social-links is declarative. List-items are rendered in the order declared in the downstream configuration file and not merged
345- with entries from upstream config file(s) such as theme-config-file or prior local config files.
346- - The `user_url` is rendered as given without handling any special characters within.
299+ where `title` corresponds to the link-title displayed when a visitor hovers mouse-pointer over url / icon and
300+ ` icon` refers to the Font Awesome icon id. e.g. `github` corresponds to `fa-github`.
301+
302+ Social platform icons are rendered using the latest version of Font Awesome Free webfonts sourced via remote CDN.
303+ The full list of available social icons can be found at https://fontawesome.com/search?ic=brands
347304
348305
349306# ## Enabling Google Analytics
0 commit comments