Skip to content

Commit

Permalink
update icons documentation
Browse files Browse the repository at this point in the history
Signed-off-by: weru <[email protected]>
  • Loading branch information
onweru committed Feb 3, 2023
1 parent 69c7a56 commit 407b728
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,7 @@ These options set global values that some pages or all pages in the site use by
| mainSections | array/string | no |
| centerLogo | boolean | no |
| logo | file path (string) | no |
| icons | Array of icon name (string) | no |
| iconsDir | dir path (string) | no |
| mobileNavigation | string | no |
| figurePositionShow | boolean | yes |
Expand Down Expand Up @@ -309,6 +310,20 @@ To edit your social media profile links, edit the files referenced above. Specif

If you wish to globally use a [large Twitter summary card](https://developer.twitter.com/en/docs/twitter-for-websites/cards/overview/summary-card-with-large-image) when sharing posts, set the global parameter `largeTwitterCard` to `true`.

Social media icons are loaded as SVG sprites. Check if your platform icons is listed under `layouts/partials/sprites` directory. If not, grab an svg icon, [convert it into a sprite](https://svgsprit.es/) and add a filename under the aforementioned dir. Make sure the ID in the sprite matches this filename.

Finally, got to `config/_default/params.toml` and ensure that icon is listed under the `icons` array. Like so:

```toml
icons = [
...
"mastodon",
...
]
```

If you're not using certain icons, remove them from the list.

### Web site analytics

If using Google Analytics, configure the `ga_analytics` global parameter in your site with your ID.
Expand Down
15 changes: 15 additions & 0 deletions exampleSite/config/_default/params.toml
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,21 @@ usePageBundles = false
imagesDir = "images/" # without a leading forward slash
# Icons:
iconsDir = "icons/" # without a leading forward slash
# Only load icons that you're actually using on your website. Remove from or add to the list below: If an icon doesn't show after adding it to this least, ensure it exists under `layouts/partials/sprites` directory.
icons = [
"facebook",
"twitter",
"linkedin",
"github",
"gitlab",
"rss",
"instagram",
"youtube",
"discord",
"stackoverflow",
"mastodon",
"xing"
]
# Fonts:
fontsDir = "fonts/" # without a leading forward slash

Expand Down

0 comments on commit 407b728

Please sign in to comment.