-
Notifications
You must be signed in to change notification settings - Fork 891
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #77 from jono-alderson/develop
Addition of RSS feeds page
- Loading branch information
Showing
2 changed files
with
29 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters