scuti/pleroma-comments
1
0
Fork 0
mirror of https://notabug.org/scuti/pleroma-comments synced 2025-01-05 17:43:48 +05:30
Code Issues Actions Packages Projects Releases Wiki Activity

updated readme for new variables

Browse Source
This commit is contained in:
scuti 2024-12-06 17:38:35 -08:00
parent 799e7ae0bd
commit 9c02e55d51
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -11,7 +11,12 @@ The filter uses the variable `pleroma-urls` for input which can be defined in th
* `pleroma-urls`: a list of strings that should contain the URLs of the posts to source replies from.
The filter exports variables that can be used in a pandoc template.
The following are optional. If both are defined, the script will not hotlink avatars and download them. If multiple pages will be storing avatars in the same folder, use Lua by creating a `config.lua` and assigning the variable there. If a specific page will have its own directory for images, define the variable in the YAML header.
* (lua) `pleroma_avatar_path`: (yaml) `pleroma-avatar-path`: a string ending in `/`, the folder containing avatars as referenced by the web page (e.g `<img src="(pleroma-avatar-path)/avatar.png"/>`).
* (lua) `pleroma_avatar_save_path`: (yaml) `pleroma-avatar-save-path`: a string ending in `/`, the folder in which avatars are downloaded to.
The filter exports variables that can be used in a Pandoc template.
* `pleroma-comments`: string, the full comments section rendered by the script.
* `pleroma-comments-count`: integer, the number of comments received by the script.