README.md in bridgetown-feed-1.0.0 vs README.md in bridgetown-feed-1.1.0

- old
+ new

@@ -18,19 +18,26 @@ ## Usage The plugin will automatically generate an Atom feed at `/feed.xml`. +### Meta tags + +The plugin exposes a helper tag to expose the appropriate meta tags to support automated discovery of your feed. Simply place `{% feed_meta %}` someplace in your template's `<head>` section, to output the necessary metadata. + ### Optional configuration options -The plugin will automatically use any of the following configuration variables, if they are present in your site's `bridgetown.config.yml` file. +The plugin will automatically use any of the following metadata variables if they are present in your site's `_data/site_metadata.yml` file. * `title` or `name` - The title of the site, e.g., "My awesome site" * `description` - A longer description of what your site is about, e.g., "Where I blog about Bridgetown and other awesome things" -* `url` - The URL to your site, e.g., `https://example.com`. If none is provided, the plugin will try to use `site.github.url`. * `author` - Global author information (see below) +In addition it looks for these `bridgetown.config.yml` settings: + +* `url` - The URL to your site, e.g., `https://example.com`. + ### Already have a feed path? Do you already have an existing feed someplace other than `/feed.xml`, but are on a host like GitHub Pages that doesn't support machine-friendly redirects? If you simply swap out `bridgetown-feed` for your existing template, your existing subscribers won't continue to get updates. Instead, you can specify a non-default path via your site's config. ```yml @@ -53,11 +60,11 @@ Additionally, the plugin will use the following values, if present in a post's YAML front matter: * `image` - URL of an image that is representative of the post (can also be passed as `image.path`) -* `author` - The author of the post, e.g., "Dr. Bridgetown". If none is given, feed readers will look to the feed author as defined in `bridgetown.config.yml`. Like the feed author, this can also be an object or a reference to an author in `_data/authors.yml` (see below). +* `author` - The author of the post, e.g., "Dr. Bridgetown". If none is given, feed readers will look to the feed author as defined in `_data/site_metadata.yml`. Like the feed author, this can also be an object or a reference to an author in `_data/authors.yml` (see below). ### Author information *TL;DR: In most cases, put `author: [your name]` in the document's front matter, for sites with multiple authors. If you need something more complicated, read on.* @@ -68,11 +75,11 @@ ```yml author: twitter: MarinaDiamandis ``` -2. An `author` object, in the site's `bridgetown.config.yml`, e.g.: +2. An `author` object, in the site's `_data/site_metadata.yml`, e.g.: ```yml author: twitter: MarinaDiamandis ``` @@ -103,18 +110,14 @@ ```yml author: marina ``` -5. An author in the site's `bridgetown.config.yml`, e.g.: +5. An author in the site's `_data/site_metadata.yml`, e.g.: ```yml author: marina ``` - -### Meta tags - -The plugin exposes a helper tag to expose the appropriate meta tags to support automated discovery of your feed. Simply place `{% feed_meta %}` someplace in your template's `<head>` section, to output the necessary metadata. ### SmartyPants The plugin uses [Bridgetown's `smartify` filter](https://bridgetownrb.com/docs/templates/) for processing the site title and post titles. This will translate plain ASCII punctuation into "smart" typographic punctuation. This will not render or strip any Markdown you may be using in a title.