From f9561730f261f256cbab1e2b0e8a994efe1fbcff Mon Sep 17 00:00:00 2001 From: scuti Date: Fri, 6 Dec 2024 20:02:32 -0800 Subject: [PATCH] readme edit. less blocky text --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 820d6ef..b63a4fe 100644 --- a/README.md +++ b/README.md @@ -11,10 +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 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. +The following two are optional. If both are defined, then the script will download avatars and will not use hotlinks. -* (lua) `pleroma_avatar_path`: (yaml) `pleroma-avatar-path`: a string ending in `/`, the folder containing avatars as referenced by the web page (e.g ``). -* (lua) `pleroma_avatar_save_path`: (yaml) `pleroma-avatar-save-path`: a string ending in `/`, the folder in which avatars are downloaded to. +1. (lua) `pleroma_avatar_path`: (yaml) `pleroma-avatar-path`: a string ending in `/`, the folder containing avatars as referenced by the web page (e.g ``). +2. (lua) `pleroma_avatar_save_path`: (yaml) `pleroma-avatar-save-path`: a string ending in `/`, the folder in which avatars are downloaded to. + +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 manuscript's YAML header. The filter exports variables that can be used in a Pandoc template.