Mastodon
/
mastofeed-iframe-embed
mirror of https://github.com/fenwick67/mastofeed
1
0
Fork 0
Code Issues Releases Wiki Activity

nicer table with values and deffault values

This commit is contained in:
Nicco Kunzmann 2022-04-28 20:07:21 +00:00
parent 76857b1d74
commit a06eaac8cb
1 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -20,14 +20,15 @@ Returns a html page which displays a mastodon feed for a user URL. Note that UR
Querystring options:
| option | required | description |
| ------ | -------- | ----------- |
| `userurl` | **yes** | Mastodon/ActivityPub account URL (usually `https://${instance}/users/${username}`) or <br/> hashtag URL (usually `https://${instance}/tags/${tagname}`) |
| `feedurl` | no | a URL to a page of an ActivityPub post collection. Only used for pages beyond the first. |
| `theme` | no | either `dark`, `light` or `auto`, to select the UI theme (default is `dark`). `auto` will appear light unless the user sets up dark mode on their device. |
| `boosts` | no | whether to show boosts or not |
| `replies` | no | whether to show replies or not |
| `size` | no | the scale of the UI in percent. |
| option | required | description | value | default |
| ------ | -------- | ----------- | ----- | ------- |
| `userurl` | **yes** | Mastodon/ActivityPub account URL or hashtag URL | `https://${instance}/tags/${tagname}` <br/> `https://${instance}/users/${username}`| |
| `feedurl` | no | a URL to a page of an ActivityPub post collection. Only used for pages beyond the first. | | |
| `theme` | no | `auto` will appear light unless the user sets up dark mode on their device. | either `dark`, `light` or `auto`, to select the UI theme | `dark` |
| `boosts` | no | whether to show boosts or not | `yes` or `no` | `yes` |
| `replies` | no | whether to show replies or not | `yes` or `no` | `yes` |
| `size` | no | the scale of the UI in percent. | e.g. `200` | `100` |
| `header` | no | whether to show the user header (only for users, not hashtags) | `yes` or `no` | `no` |
## Server Installation