diff --git a/docs/features/rss-feeds/functional-specification.md b/docs/features/rss-feeds/functional-specification.md new file mode 100644 index 00000000000..4cdbbfb0371 --- /dev/null +++ b/docs/features/rss-feeds/functional-specification.md @@ -0,0 +1,28 @@ +--- +id: overview +title: RSS Feeds - API specification +sidebar_label: Overview +custom_edit_url: https://github.com/Yoast/developer-docs/edit/master/docs/features/rss-feeds/functional-specification.md +description: This documentation explains Yoast SEO modifies RSS feeds. +--- +This documentation provides technical information about how [Yoast SEO](https://yoast.com/wordpress/plugins/seo/) modifies RSS feeds. + +For any feed(s) of public posts/pages*, Yoast SEO allows the user to automatically prefix and/or append a dynamic content string (for the purposes of branding, attribution or similar). + +\*Excluding WordPress' "comment feeds". + +## Default settings +The default prefix setting (_"Content to put before each post in the feed"_) is blank/empty. + +The default suffix setting (_"Content to put after each post in the feed"_) is `The post %%POSTLINK%% appeared first on %%BLOGLINK%%.`. + +## Replacement variables + +The following variables are available, and are automatically replaced in the generated prefix/suffix. + +| Variable | Description | +|--|----| +| `%%AUTHORLINK%%` | A link to the archive for the post author, with the _author's name_ as anchor text. | +| `%%POSTLINK%%` | A link to the post, with the _title_ as anchor text. | +| `%%BLOGLINK%%` | A link to your site, with your _site's name_ as anchor text. | +| `%%BLOGDESCLINK%%` | A link to your site, with the _site's name and description_ as anchor text. | diff --git a/docs/features/schema/api.md b/docs/features/schema/api.md index ccb1bb1ace1..d5cf7cd2f46 100644 --- a/docs/features/schema/api.md +++ b/docs/features/schema/api.md @@ -1,7 +1,7 @@ --- id: api title: Schema - API documentation -sidebar_label: API +sidebar_label: Schema API custom_edit_url: https://github.com/Yoast/developer-docs/edit/master/docs/features/schema/api.md description: Instructions on how to modify our schema output programmatically. ---