jadedctrl/fedi2html
jadedctrl/ fedi2html
1
0
Disbranĉigi 0
Fontkodo Issues Tirpetoj Activity
Render a fediverse post into portable text, like HTML.
19 Enmetoj 1 Branĉo 0 Etikedoj 265 KiB
Shell 88.9%
CSS 11.1%
Iri al dosiero
Jaidyn Ann b3c7a3fb3b Add README.md 2024-04-25 18:41:25 -05:00
img Add screenshots 2024-04-25 18:41:19 -05:00
COPYING Add GPLv3 license 2024-04-25 18:41:12 -05:00
README.md Add README.md 2024-04-25 18:41:25 -05:00
fedi2html Add header-info to fedi2html 2024-04-25 18:40:32 -05:00
style.css Add example CSS file 2024-04-25 18:41:04 -05:00

README.md

fedi2html

Clipping from a screenshot of a webpage generated by fedi2html. It is showing a legibly-formatted post, containing the username, text, date, and an attachement plus thumnail. The post is by “jadedctrl”, posted apparently at 14:19 on April 15th 2024, and says: “Kaj nun miaj tagoplanoj presiĝos per punkpresilo! ^^”. The below hashtags are visible as links: #presilo, #planado, and #kalendaro. The attachment is an image called “kalendaro.jpg”, whose thumbnail is visible. Also visible is some of the image’s alt-text, reading “Foto de presita papero, sur kiu videblas du kolumnojn…” Clipping from a screenshot of a webpage generated by fedi2html. A chain of three posts, each replying to the last, are visible. Each post is within a small box, containing the poster’s avatar, user-name, and text. Each response is found within a smaller box within the parent post, showing a clear hierarchy in the thread. Reid posts, mentioning jadedctrl, “but would you ask spicy questions?” jadedctrl responds, “I like using a lot of spice myself, but because of the high sodium content I couldn’t recommend a diet like that to other people on good conscious”. jadedctrl also responds with a custom emoji of a laughing blobcat. Reid responds to that response, “a life without spice is like GTA without crime: too damn boring”.

fedi2html is a shell script that renders posts from Fediverse/Mastodon/Pleroma/etc to HTML. It could be used for archiving posts, embedding comments into a webpage, etc; the latter is my use-case.

Inspired by the work of Óscar Otero, who was inspired by Thiago Cerqueira, who was inspired by Julian Fietkau, who was in turn inspired by Cassidy James, who also was inspired by Jan Wildeboer who was inspired by Yidhra Farm, who was inspired by Joel Chrono who was inspired by Carl Schwan.

Usage

fedi2html can take post URLs or user URLs. In the first case, it will render the post and, by default, all respones. If a user URL is given, it will by default render the user’s posts, responses, and repeats; and all responses to these.

$ echo '<html><head><link rel="stylesheet" href="style.css" type="text/css"/></head>' > out.html
$ fedi2html https://jam.xwx.moe/users/Tirifto >> out.html
$ fedi2html https://jam.xwx.moe/notice/AfJdu8YChrGdHXmOpM >> out.html

Of course, the output is unstylized HTML, including no CSS; for best results, I’d recommend using the style.css file found in this directory, as is done above (by prepending its inclusion in a tag).

There are three general arguments you should be aware of: | -c | Only print responses to the post(s). | | -I | Display posts in reverse-chronological order. | | -l NUM | Display at maximum NUM posts. | | -R | Do not recursively fetch & display responses. |

… and three arguments relating specifically to user feeds: | -b | Exclude reblogs/repeats. | | -B | Exclude top-level replies. | | -t TAG | Only print posts of TAG. |

Installation

Installing fedi2html itself than simple — just copy into your PATH!

Assuming that you use ~/.local/bin/:

$ PATH="$PATH:~/.local/bin/"
$ chmod +x fedi2html
$ cp fedi2html ~/.local/bin/

Dependencies

However, fedi2html has some dependencies:

  • curl — For fetching/downloading posts.
  • jq — For parsing the resultant JSON.

They are both fairly standard, and are generally accessible as packages curl and jq, respectively. In the rare cases they aren’t, both are written in C and are easily-compilable.

Misc

Written by Jaidyn Ann jadedctrl@posteo.at
License is GNU GPLv3
Source is at https://hak.xwx.moe/jadedctrl/fedi2html