eleventy-plugin-podcaster 0.9.2 → 0.9.3

package/README.md

@@ -2,7 +2,6 @@
 
 `eleventy-plugin-podcaster` — or **Podcaster**, as we will call it from now on — lets you use Eleventy to create a podcast and its accompanying website. **Podcaster** creates the podcast feed that you submit to Apple Podcasts, Spotify or any other podcast directory. And it provides information about your podcast to your Eleventy templates. This means that you can include information about the podcast and its episodes on your podcast's website, creating pages for individual episodes, guests, topics, seasons or anything else at all.
 
-
 ## Installation
 
 To install the npm package, type this at the command line:

package/docs/optional-features.md

@@ -12,7 +12,8 @@ export default function (eleventyConfig) {
   .
   eleventyConfig.addPlugin(podcasterPlugin, {
     handleDrafts: true,
-    handleExcerpts: true
+    handleExcerpts: true,
+    readableDateLocale: 'en-GB'
   })
   .
   .
@@ -34,3 +35,9 @@ Excerpts are available in a template as `{{ excerpt }}`, but you will probably a
 1. As an `excerpt` field in the post's front matter. This should be written in Markdown.
 2. The part of the post between the excerpt delimiters `<!---excerpt-->` and `<!---endexcerpt-->` .
 3. The first paragraph in the post which is not nested inside another tag. (This is so that a blockquote at the beginning of a post isn't included in the excerpt.)
+
+## `readableDate` filter
+
+**Podcaster** optionally provides a `readableDate` filter, to match `readableDuration` and `readableSize`. It transforms a date into a localised string, which usually includes weekday, day of month, month and year.
+
+To make **Podcaster** provide this filter, pass a locale string as one of the options when you're adding the plugin to your config file. In English, the two most common locale strings are `'en-GB'` and `'en-US'`.

package/eleventy.config.js

@@ -56,15 +56,17 @@ export default function (eleventyConfig, options = {}) {
 
   eleventyConfig.addShortcode('year', () => DateTime.now().year)
 
-  eleventyConfig.addFilter('readableDate', function (date) {
-    if (date instanceof Date) {
-      date = date.toISOString()
-    }
-    const result = DateTime.fromISO(date, {
-      zone: 'UTC'
+  if (options.readableDateLocale) {
+    eleventyConfig.addFilter('readableDate', function (date) {
+      if (date instanceof Date) {
+        date = date.toISOString()
+      }
+      const result = DateTime.fromISO(date, {
+        zone: 'UTC'
+      })
+      return result.setLocale(options.readableDateLocale).toLocaleString(DateTime.DATE_HUGE)
     })
-    return result.setLocale('en-GB').toLocaleString(DateTime.DATE_HUGE)
-  })
+  }
 
   eleventyConfig.addFilter('readableDuration', function (seconds) {
     if (!seconds) return '0:00:00'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eleventy-plugin-podcaster",
-  "version": "0.9.2",
+  "version": "0.9.3",
   "description": "An Eleventy plugin that allows you to create a podcast and its accompanying website",
   "main": "eleventy.config.js",
   "exports": {

package/src/podcastFeed.njk

@@ -29,7 +29,7 @@ eleventyAllowMissingExtension: true
     {%- else %}
     <itunes:category text="{{ podcast.category }}" />
     {%- endif %}
-    <itunes:image href="{{ podcast.imagePath | htmlBaseUrl(podcast.siteUrl) }}"></itunes:image>
+    <itunes:image href="{{ podcast.imagePath | htmlBaseUrl(siteUrl) }}"></itunes:image>
     <itunes:summary>{{ podcast.summary or podcast.description }}</itunes:summary>
     {% if podcast.explicit !== undefined %}<itunes:explicit>{{ podcast.explicit or "false" }}</itunes:explicit>{% endif -%}
     {%- if podcast.type %}
@@ -46,24 +46,35 @@ eleventyAllowMissingExtension: true
     {% for post in collections.podcastEpisode | reverse %}
     <item>
       <title>{{ post.data.title }}</title>
-      <link>{{ post.url | htmlBaseUrl(podcast.siteUrl) }}</link>
+      <link>{{ post.url | htmlBaseUrl(siteUrl) }}</link>
       <pubDate>{{ post.date | dateToRfc3339 }}</pubDate>
       {% if post.data.episode.seasonNumber -%}
       <itunes:season>{{ post.data.episode.seasonNumber }}</itunes:season>
       {%- endif %}
       <itunes:episode>{{ post.data.episode.episodeNumber }}</itunes:episode>
-      <itunes:summary>{{ post.content | striptags(true) | truncate(800) }}</itunes:summary>
-      <description>{{ post.content | striptags(true) | truncate(800) }}</description>
+      {% if podcast.feedEpisodeDescriptionTemplate %}
+      {%- set episodeDescription -%}
+      {% include podcast.feedEpisodeDescriptionTemplate %}
+      {%- endset -%}
+      {% else %}
+      {%- set episodeDescription = post.content | striptags(true) | truncate(800) -%}
+      {%- endif %}
+      <itunes:summary>{{ episodeDescription }}</itunes:summary>
+      <description>{{ episodeDescription }}</description>
       {% if podcast.feedEpisodeContentTemplate %}
       {%- set episodeContent -%}
       {% include podcast.feedEpisodeContentTemplate %}
       {%- endset -%}
+      {% else %}
+      {%- set episodeContent = post.content -%}
+      {% endif %}
+      {%- if post.data.page -%}
       <content:encoded>
-        <![CDATA[{{ episodeContent | renderTransforms(post.data.page, podcast.siteUrl) | safe | trim }}]]>
+        <![CDATA[{{ episodeContent | renderTransforms(post.data.page, siteUrl) | safe | trim }}]]>
       </content:encoded>
       {%- else -%}
       <content:encoded>
-        <![CDATA[{{ post.content | renderTransforms(post.data.page, podcast.siteUrl) | safe | trim }}]]>
+        <![CDATA[{{ post.content | renderTransforms(post.data.page, siteUrl) | safe | trim }}]]>
       </content:encoded>
       {% endif %}
       <enclosure url="{{ post.data.episode.url }}" length="{{ post.data.episode.size }}" type="audio/mp3"></enclosure>
@@ -71,7 +82,7 @@ eleventyAllowMissingExtension: true
       {%- if post.data.guid != undefined %}
       <guid isPermalink="false">{{ post.data.episode.guid }}</guid>
       {% else %}
-      <guid isPermalink="true">{{ post.url | htmlBaseUrl(podcast.siteUrl) }}</guid>
+      <guid isPermalink="true">{{ post.url | htmlBaseUrl(siteUrl) }}</guid>
       {% endif -%}
       {%- if post.data.explicit != undefined %}
       <itunes:explicit>{{ post.data.explicit }}</itunes:explicit>