diff options
Diffstat (limited to 'REFERENCE.md')
| -rw-r--r-- | REFERENCE.md | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/REFERENCE.md b/REFERENCE.md index 12cd869..721492c 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -60,6 +60,7 @@ These should be set under the `[params]` section: | `soundcloud_subscribe` | No | The URL to your podcast's feed on Soundcloud | "http://feeds.soundcloud.com/users/soundcloud:users:203144248/sounds.rss" | | `pocketcasts_subscribe` | No | The URL to your podcast's feed on Pocketcasts | "http://pcasts.in/feed/feeds.soundcloud.com/users/soundcloud:users:203144248/sounds.rss" | | `spotify_subscribe` | No | The URL to your podcast's page on Spotify | "https://open.spotify.com/show/7hHA2ZlfOmbwv96wEBaMR2?si=UeVjoWIVSqqLluJd4TlEUg" | +| `youtube_subscribe` | No | The URL to subscribe your podcast's channel on Spotify | "https://www.youtube.com/arresteddevops?sub_confirmation=1" | | `mailchimp_subscribe` | No | The URL for your MailChimp signup form. This can be acquired from creating a "Super Slim" Embedded form on MailChimp. Do NOT include the entire form HTML; you just need the path for the `form action`. | "//arresteddevops.us3.list-manage.com/subscribe/post?u=5e4cbcac996bb9df25f970a89&id=154fa76bcc" | | `rss_subscribe` | No | Optional parameter to over-ride the RSS feed URL, in case you use something like Feedburner. You likely do NOT need to set this parameter unless you have a very good reason to do so. | "http://feeds.podtrac.com/VGAulpN7MY1U" | | `description` | Yes | Description of your show. Can use Markdown. | `"The HugoCast is the best podcast you've ever seen. You will learn everything you ever needed to know about [podcasting](https://en.wikipedia.org/wiki/Podcast) from the most inspiring experts to ever show up on the whole internet."` | @@ -99,7 +100,7 @@ Refer to https://realfavicongenerator.net/ for more details. ### Social Parameters -These are the social network parameters for your overall site. They should be set under `[params.social]` +These are the social network parameters for your overall site. They should be set under `[params.social]` and all of them allow either the short form (e.g. just your twitter handle) where the theme will construct the URL or the full URL beginning with https:// | Field Name | Required | Description | Example | |------------------|----------|------------------------------------------------------------------------------------------------------------------|----------------------| @@ -137,7 +138,7 @@ We use the "authors" from the configuration to list hosts in the jumbotron or si TODO: Remove these parameters from exampleSite, but also add one for the the shortname of the host for linking to host page (optional) -You also will set the social parameters (all are optional) under `[params.authors.USERNAME.social]` +You also will set the social parameters (all are optional) under `[params.authors.USERNAME.social]` and all of them allow either the short form (e.g. just your twitter handle) where the theme will construct the URL or the full URL beginning with https:// | Field Name | Required | Description | Example | |-------------|----------|------------------------------------------------------------------------------------------------------------------|--------------------------------| @@ -245,12 +246,12 @@ Example: identifier = "podcasts" url = "books" parent = "resources" - + ``` ### Podlove Subscribe Button -[Podlove Subscribe Button](https://subscribe-button.podlove.org/) is a universal and easy-to-use button, to subscribe to podcasts with player clients or website players. +[Podlove Subscribe Button](https://subscribe-button.podlove.org/) is a universal and easy-to-use button, to subscribe to podcasts with player clients or website players. To customize your button please add the following section to your `config.toml`, which covers all features which are provided by the generator on [subscribe-button.podlove.org](https://subscribe-button.podlove.org/). ``` @@ -375,7 +376,7 @@ Graphical user interface influencer value proposition startup hackathon iPad ana | `tags[]` | No | If you are using taxonomies, this is the array of tags for the epsiode. | ["VR", "Technology"] | ### Upcoming Episodes -If you would like to display upcoming episodes, you need to do a couple things. First, you will need to create a page where the upcoming episodes will be listed. You can check out `exampleSite` for an example, but basically, you want to create `content/upcoming/_index.md`. +If you would like to display upcoming episodes, you need to do a couple things. First, you will need to create a page where the upcoming episodes will be listed. You can check out `exampleSite` for an example, but basically, you want to create `content/upcoming/_index.md`. Any episodes that have `upcoming` in their frontmatter set to `true` will be listed here, but not listed on any other pages (feed, home page, guest pages, etc). Additionally, episodes that are marked as "upcoming" will not display a YouTube video or audio player, even if those parameters are set. |