Skip to content

Commit

Permalink
Merge pull request #77 from jono-alderson/develop
Browse files Browse the repository at this point in the history
Addition of RSS feeds page
  • Loading branch information
jonoalderson authored Jul 27, 2020
2 parents 8b79045 + 9bbbace commit 75fe19c
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 1 deletion.
28 changes: 28 additions & 0 deletions docs/features/rss-feeds/functional-specification.md
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. |
2 changes: 1 addition & 1 deletion docs/features/schema/api.md
Original file line number Diff line number Diff line change
@@ -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.
---
Expand Down

0 comments on commit 75fe19c

Please sign in to comment.