diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api/swagger.yaml | 8 | ||||
| -rw-r--r-- | docs/assets/rss.svg | 18 | ||||
| -rw-r--r-- | docs/user_guide/rss.md | 15 |
3 files changed, 41 insertions, 0 deletions
diff --git a/docs/api/swagger.yaml b/docs/api/swagger.yaml index 78c4f0559..e09d07f14 100644 --- a/docs/api/swagger.yaml +++ b/docs/api/swagger.yaml @@ -268,6 +268,10 @@ definitions: $ref: '#/definitions/emoji' type: array x-go-name: Emojis + enable_rss: + description: Account has enabled RSS feed. + type: boolean + x-go-name: EnableRSS fields: description: Additional metadata attached to this account's profile. items: @@ -2576,6 +2580,10 @@ paths: in: formData name: custom_css type: string + - description: Enable RSS feed for this account's Public posts at `/[username]/feed.rss` + in: formData + name: enable_rss + type: boolean produces: - application/json responses: diff --git a/docs/assets/rss.svg b/docs/assets/rss.svg new file mode 100644 index 000000000..11fd98a59 --- /dev/null +++ b/docs/assets/rss.svg @@ -0,0 +1,18 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd"> +<svg xmlns="http://www.w3.org/2000/svg" version="1.1" width="128px" height="128px" id="RSSicon" viewBox="0 0 256 256"> +<defs> +<linearGradient x1="0.085" y1="0.085" x2="0.915" y2="0.915" id="RSSg"> +<stop offset="0.0" stop-color="#E3702D"/><stop offset="0.1071" stop-color="#EA7D31"/> +<stop offset="0.3503" stop-color="#F69537"/><stop offset="0.5" stop-color="#FB9E3A"/> +<stop offset="0.7016" stop-color="#EA7C31"/><stop offset="0.8866" stop-color="#DE642B"/> +<stop offset="1.0" stop-color="#D95B29"/> +</linearGradient> +</defs> +<rect width="256" height="256" rx="55" ry="55" x="0" y="0" fill="#CC5D15"/> +<rect width="246" height="246" rx="50" ry="50" x="5" y="5" fill="#F49C52"/> +<rect width="236" height="236" rx="47" ry="47" x="10" y="10" fill="url(#RSSg)"/> +<circle cx="68" cy="189" r="24" fill="#FFF"/> +<path d="M160 213h-34a82 82 0 0 0 -82 -82v-34a116 116 0 0 1 116 116z" fill="#FFF"/> +<path d="M184 213A140 140 0 0 0 44 73 V 38a175 175 0 0 1 175 175z" fill="#FFF"/> +</svg>
\ No newline at end of file diff --git a/docs/user_guide/rss.md b/docs/user_guide/rss.md new file mode 100644 index 000000000..560868c0b --- /dev/null +++ b/docs/user_guide/rss.md @@ -0,0 +1,15 @@ +# RSS + +RSS stands for [Really Simple Syndication](https://en.wikipedia.org/wiki/RSS). It's a very well established standard for sharing content on the web. You might recognize the jolly orange RSS logo from your favorite news websites and blogs: + + + +If you like, you can configure your GoToSocial account to expose an RSS feed of your posts to the web. This allows people to get regular updates about your posts even when they don't have a Fediverse account. This is great when you're using GoToSocial to create longer-form, blog style posts, and you want anyone to be able to read them easily. + +The RSS feed for GoToSocial profiles is turned off by default. You can enable it via the [User Settings Panel](./user_panel.md) at `https://[your-instance-domain]/settings`. + +When enabled, the RSS feed for your account will be available at `https://[your-instance-domain]/@[your_username]/feed.rss`. If you use an RSS reader, you can point it at this address to check that RSS is working. + +## Which posts are shared via RSS? + +Only your latest 20 Public posts are shared via RSS. Replies and reblogs/boosts are not included. Unlisted posts are not included. In other words, the only posts visible via RSS will be the same ones that are visible when you open your profile in a browser. |
