adulau/mastodon-markdown-archive
1
0
Fork 0
mirror of https://github.com/adulau/mastodon-markdown-archive.git synced 2024-11-21 17:37:06 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add sprig example to README

Browse source
This commit is contained in:
Gabriel Garrido 2024-08-03 18:07:27 +02:00
parent 566e47a1f5
commit d18757447e
1 changed files with 16 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -307,6 +307,22 @@ For both the post and filename templates, the following functions and variables
* `toMarkdown` to convert the post's HTML content to Markdown, without escaping any markdown syntax
* `toMarkdownEscaped` to convert the post's HTML content to Markdown, escaping any markdown syntax
Sprig is particularly useful for arbitrary customization, such as [string manipulation](https://masterminds.github.io/sprig/strings.html).
For example, let's assume we want to convert the casing of the tags from Mastodon. The [default template](files/templates/post.tmpl) passes the tags as-is, but we want them in kebab-case. You would need to create a custom template, and use the `kebabcase` function where the tags are rendered:
```
---
date: {{ .Post.CreatedAt }}
tags:
{{- range .Post.AllTags }}
- {{ .Name | kebabcase }}
{{- end }}
---
```
You would keep this file somewhere, and pass its path to the `--template` argument when invoking the tool.
#### Variables
* [Post](https://pkg.go.dev/git.garrido.io/gabriel/mastodon-markdown-archive/client#Post)