diff --git a/exampleSite/content/docs/content-examples/index.md b/exampleSite/content/docs/content-examples/index.md index 35270195..f09a99f2 100644 --- a/exampleSite/content/docs/content-examples/index.md +++ b/exampleSite/content/docs/content-examples/index.md @@ -90,6 +90,64 @@ _In this example, the special `cascade` parameter is being used to hide the read The [samples section]({{< ref "samples" >}}) of this site is an example of a list page. +### Linktree Page + +| | | +| -------------- | --------------------------------------------- | +| **Layout:** | `linktree` (e.g. `layouts/_default/linktree.html`) | +| **Content:** | `content/links/_index.md` | + +The [Linktree Page](/links) enables you to quickly build a page that displays a list of links—similar to Linktree. This component pulls links from two sources: + +- Page Front Matter: + You can directly define custom links in the Markdown file. +- Author Social Links: + It also automatically appends social links defined in the Author configuration. + +**How It Works** + +The component retrieves the links parameter from the page’s front matter. Each link is defined as a mapping, with the link text as the key and the destination URL as the value. After rendering these links, the component will also include the social links configured under `.Site.Params.Author.Links`` at the bottom of the page. + +**Usage** + +In your Markdown file, set the layout to `linktree` and define your links like this: + +```yaml +--- +layout: linktree +links: + - "Awesome Masterclass": "https://example.com" +--- +``` + +*Note:* +- Each link is an item in a list. +- The key (e.g., `"Awesome Masterclass"`) represents the text to display. +- The value (e.g., `"https://example.com"`) is the URL where the link should navigate. + +**Directory Structure** + +For example, you might organize your site as follows: + +```shell +. +└── content + └── links + └── _index.md +``` + +**Adding More Links:** + To add more links, simply update the front matter in your Markdown file by adding more items to the `links` list: + + ```yaml + --- + layout: linktree + links: + - "Awesome Masterclass": "https://example.com" + - "Another Resource": "https://example.com" + --- + ``` + ### Taxonomy pages | | | diff --git a/exampleSite/content/links/_index.md b/exampleSite/content/links/_index.md new file mode 100644 index 00000000..dc0b20e7 --- /dev/null +++ b/exampleSite/content/links/_index.md @@ -0,0 +1,5 @@ +--- +layout: linktree +links: + - "Awesome Master Class": "https://example.com" +--- \ No newline at end of file diff --git a/layouts/_default/linktree.html b/layouts/_default/linktree.html new file mode 100644 index 00000000..bffffaa4 --- /dev/null +++ b/layouts/_default/linktree.html @@ -0,0 +1,43 @@ +{{ define "main" }} +{{ $disableImageOptimization := .Site.Params.disableImageOptimization | default false }} +
+ {{ with .Site.Params.Author.image }} + {{ $authorImage := "" }} + {{ if or (strings.HasPrefix . "http:") (strings.HasPrefix . "https:") }} + {{ $authorImage = resources.GetRemote . }} + {{ else }} + {{ $authorImage = resources.Get . }} + {{ end }} + {{ if $authorImage }} + {{ if not $disableImageOptimization }} + {{ $authorImage = $authorImage.Fill "192x192" }} + {{ end }} + {{ $.Site.Params.Author.name | default + {{ else }} + {{ $authorImage := resources.GetRemote . }} + {{ if not $disableImageOptimization }} + {{ $authorImage = $authorImage.Fill "192x192" }} + {{ end }} + {{ $.Site.Params.Author.name | default + {{ end }} + {{ end }} + + {{ with .Site.Params.Author.name | markdownify }} +
+ {{ . }} +
+ {{ end }} +
+
+
+

+ {{ .Title | emojify }} +

+
+
+ {{ partial "linktree-list.html" . }} +
+
+{{ end }} diff --git a/layouts/partials/linktree-list.html b/layouts/partials/linktree-list.html new file mode 100644 index 00000000..f755c851 --- /dev/null +++ b/layouts/partials/linktree-list.html @@ -0,0 +1,34 @@ +
+
+ {{ $siteLinks := .Site.Params.Author.Links | default (slice) }} + {{ $pageLinks := .Params.Links | default (slice) }} + {{ $allLinks := slice }} + + {{ range $link := $pageLinks }} + {{ $allLinks = $allLinks | append $link }} + {{ end }} + + {{ range $link := $siteLinks }} + {{ $allLinks = $allLinks | append $link }} + {{ end }} + + {{ if gt (len $allLinks) 0 }} + {{ range $links := $allLinks }} + {{ range $name, $url := $links }} + + {{ $icon := resources.Get (print "icons/" $name ".svg") }} + {{ if $icon }} + + {{ $icon.Content | safeHTML }} + + {{ end }} + {{ $name }} + + {{ end }} + {{ end }} + {{ else }} +

No links configured.

+ {{ end }} +
+
+ \ No newline at end of file