cecil/theme-podcast

Cecil component theme: Podcast

Fund package maintenance!
ArnaudLigny
Open Collective

Installs: 824

Dependents: 1

Suggesters: 0

Security: 0

Stars: 0

Watchers: 2

Forks: 0

Open Issues: 0

Language:Twig

Type:cecil-theme

2.0.1 2024-03-12 10:55 UTC

README

The Podcast component theme for Cecil provide templates to publish an audio show on the web:

  1. a RSS output for the episodes section (with a style sheet)
  2. a HTML audio player with resume feature and Media Session API support

Installation

composer require cecil/theme-podcast

Or download the latest archive and uncompress its content in themes/podcast.

Usage

Add podcast in the theme section of your config.yml:

theme:
  - podcast

Add podcast configuration details in your config.yml:

podcast:
  owner:
    name: Cecil
    email: contact@cecil.app
  image: cover.png
  author: Cecil  # optional
  categories:    # https://podcasters.apple.com/support/1691-apple-podcasts-categories
    - Technology
  type: episodic # optional, "episodic" (default) or "serial"
  explicit: no   # optional
  block: no      # optional
  newfeedurl: "" # optional, the URL of the new feed in case of hosting changement

Add a Markdown file in episodes section with data (in the front matter) and description:

1.md:

---
title: "Episode X"
date: YYYY-MM-DD
episode:
  file: episode-X.mp3
  season: 0    # optional
  number: X    # optional
  type: full   # optional, "full", "trailer" or "bonus"
  explicit: no # optional
  block: no    # optional
---
Description and notes of the episode.

Add the HTML player to your episode's template:

{% include 'partials/audioplayer.html.twig' %}