diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 76 |
1 files changed, 59 insertions, 17 deletions
@@ -11,7 +11,7 @@ Castanet is a a Hugo theme for sites that are primarily podcasts. It is heavily An example site can be found at http://sample-castanet.netlify.com/ - + ## Installation @@ -45,6 +45,7 @@ You will need to add a handful of configuration items to your `config.toml` file - `mailchimp_subscribe` - The URL for your MailChimp signup form. This can be acquired from creating a "Super Slim" Embedded form on MailChimp. Additional instructions may be provided later. Do NOT include the entire form HTML; you just need the path for the `form action`. Optional. Example: `"//arresteddevops.us3.list-manage.com/subscribe/post?u=5e4cbcac996bb9df25f970a89&id=154fa76bcc"` - `rss_subscribe` - 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. - `description` - Description of your show. Can use Markdown. Example: `"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."` + - `media_prefix` - The URL to pre-pend to your podcast files. Must end in a slash. Example: `"https://media.blubrry.com/arresteddevops/content.blubrry.com/arresteddevops/"` - ``[params.feed]`` - these are items used to configure your podcast feed. - `feed_copyright` - The copyright information for your feed. Do not use Markdown. Example: `"Copyright 2016 Matt Stratton"` - `itunes_subtitle` - No Markdown or HTML. Example: `"The best podcast ever"` @@ -82,7 +83,7 @@ You will need to add a handful of configuration items to your `config.toml` file #### A note about `BaseURL` -This theme is fairly dependent upon a proper `BaseURL` being set in the `config.toml`. This has to do with how the feed is generated as well as some of the social metadata (these things cannot be relative URL's). I'm fully aware that this can cause issues with some build systems, and I'm trying to work on a good solution for this. +This theme is fairly dependent upon a proper `BaseURL` being set in the `config.toml`. This has to do with how the feed is generated as well as some of the social metadata (these things cannot be relative URL's). I'm fully aware that this can cause issues with some build systems, and I'm trying to work on a good solution for this. This must end in a slash. Example: `https://www.arresteddevops.com/` #### Permalinks @@ -96,11 +97,56 @@ I recommend the following permalink settings, although the theme will work just episode = "/:filename/" ``` +### Episodes + +Every episode requires a page in the `content/episode` on your site. The command `hugo new episode/myepisod.md` should populate it properly. + +An episode file takes the following structure: + +``` ++++ +Description = "Bootstrapping alpha seed money scrum project. Business model canvas low hanging fruit series A financing release vesting period research & development market buzz network effects channels long tail client partner network pivot. Innovator market android buyer gamification. User experience gamification interaction design sales. Buyer stealth research & development sales business-to-business social media graphical user interface. Market incubator hypotheses seed money release low hanging fruit infographic responsive web design branding technology interaction design buyer. Ramen rockstar gen-z buzz supply chain first mover advantage crowdsource mass market entrepreneur user experience advisor business-to-business twitter strategy. Termsheet low hanging fruit lean startup crowdfunding customer. Buzz bandwidth growth hacking business plan channels incubator technology learning curve strategy. Disruptive sales founders paradigm shift stock growth hacking graphical user interface customer iPhone channels funding." +aliases = ["/12"] +author = "Matt" +date = "2016-09-25T04:10:01-05:00" +episode = "12" +episode_image = "img/episode/default.jpg" +explicit = "no" +guests = ["jsmith"] +images = ["img/episode/default-social.jpg"] +podcast_duration = "1:08:22" +podcast_file = "arrested-devops-podcast-episode053.mp3" +podcast_bytes = "123456789" +title = "Back to School" +youtube = "" + ++++ + +Graphical user interface influencer value proposition startup hackathon iPad analytics gen-z entrepreneur release traction product management long tail. Buzz business-to-consumer android learning curve innovator seed money iteration buyer startup. Holy grail graphical user interface responsive web design lean startup bandwidth strategy release innovator low hanging fruit non-disclosure agreement. Strategy handshake iPhone interaction design early adopters. Low hanging fruit crowdfunding vesting period. Low hanging fruit social proof series A financing product management founders bootstrapping ecosystem buyer supply chain hackathon direct mailing churn rate client. Scrum project direct mailing ecosystem monetization innovator. Partner network gen-z conversion pivot iPhone infographic growth hacking business plan facebook alpha marketing beta technology. Focus crowdsource venture strategy user experience. Lean startup disruptive user experience stealth interaction design monetization client long tail virality seed round direct mailing hypotheses technology burn rate. +``` + +| Field Name | Required | Description | Example | +|--------------------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `Description` | Yes | The description of the episode, which is used on summary pages as well as the feed. | "Bootstrapping alpha seed money scrum project. Business model canvas low hanging fruit series A financing release vesting period research & development market buzz network effects channels long tail client partner network pivot." | +| `aliases` | No | Other aliases for this episode. You may wish to create an alias to the episode number, etc. | ["/12"] | +| `author` | No | The name of an author from your config.toml file | "Matt" | +| `date` | Yes | The release date of the episode. The `hugo new` episode will pre-populate this, but you may want to adjust it. | "2016-09-25T04:10:01-05:00" | +| `episode` | No | The episode number. Currently unused. | "12" | +| `episode_image` | Yes | The square thumbnail to represent the episode. A default image is provided, and the archetype will pre-populate it. This image needs to be relative to your baseURL. | "img/episode/default.jpg" | +| `explicit` | Yes | Whether or not the episode contains explicit content. Default value from the archetype is "no". Valid values are "yes" or "no" | "yes" | +| `guests` | No | If your episode has guests, populate the `guests[]` array with a comma-separated list of their names. If there is only one guest, no comma is needed. | ["jdoe", "msmith", "gbluth"] or ["jsmith]" | +| `images` | No | The social sharing image used by Facebook, Twitter, etc. The archetype will populate this with a default sharing image. This image needs to be relative to your baseURL | ["img/episode/default-social.jpg"] | +| `podcast_duration` | Yes | The duration of the podcast, up to the amount of seconds. | "1:08:22" or "59:32" | +| `podcast_file` | Yes | The filename of your episode, relative to the `media_prefix` of your config.toml. | `"arrested-devops-podcast-episode053.mp3"` | +| `podcast_bytes` | No | The length of the podcast file in bytes. This is optional, but iTunes and many other podcast players prefer this to be set. | "23907533" | +| `Title` | Yes | The title of the episode. | "Back to School" | +| `youtube` | No | The ID of the YouTube video (not the full URL). Currently unusued. | "8ClZXJsgpHY" + ### Guests If you don't have guests on your episodes, feel free to ignore this section. -#### Guest pages +#### Guest Pages Every guest on your show needs a corresponding page in the `content/guest` directory of your site. Generally speaking, you should be able to name these however you like, but I have only tested it with the format `firstinitiallastname.md`, i.e., for "John Doe" the file would be `jdoe.md`. @@ -115,23 +161,19 @@ Type = "guest" Facebook = "johndoe" Linkedin = "johndoe" GitHub = "johndoe" -Thumbnail = "/img/guest/jdoe.jpg" +Thumbnail = "img/guest/jdoe.jpg" +++ Spoon fresh pie ingredients groceries oranges luncheon farm. Broth chick peas Chinese food indie foods. Cream heating cheese food locally grown first class caramelize restaurant grocery shopping savory chick peas. Recommendations lovely starter soda herbes fridge chocolate eat better quinoa sausage java chef locally grown wholesome. Broil sweet sushi lasagna cream indian. Desert sour vegetarian sous-chef soda oven tasty eat better rice recommendations relish salt butter grape. Grocery shopping delicious Chinese food beets conserve ginger. Authentic blend drink sausage. Groceries sour desert. Take away lasagna consumer luncheon scent cookie beer groceries meals restaurants java cheese vegan chick peas. ``` -(See the example site for, well, examples) - -- `Title` - The full name of the guest. This is what is displayed on the episode page, etc. Required. -- `Thumbnail` - The image for the guest. This image must be 500 px x 500 px. You can either enter a value relative to your `BaseURL`, or a fully qualified URL. If you want to use the default, set this to `""`. Optional. If left blank, or not existent, a default image will be provided. You can replace this default image by putting a new 500 px x 500 px PNG image at `/static/img/guest/default-guest.png` in your site (not in the theme!) -- `Website` - Optional. -- `GitHub` - Guest's GitHub username. Optional. -- `Facebook` - Guest's Facebook username. Example: `matt.stratton`. Do not use the full URL. Optional. -- `Twitter` - Guest's Twitter username, without the `@`. Optional. -- `LinkedIn` - LinkedIn profile name. Optional. This is the part that comes after the `https://www.linkedin.com/in/` in your profile URL. Example: `"mattstratton"` - - -#### Frontmatter -If your episode has guests, populate the `guests[]` array with a comma-separated list of their names. For example, `["jdoe", "msmith", "gbluth"]`. If there is only one guest, no comma is needed. +| Field Name | Required | Description | Example | +|-------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------| +| `Title` | Yes | The full name of the guest. This is what is displayed on the episode page, etc. | "Jane Smith" | +| `Thumbnail` | No | The image for the guest. This image must be 500 px x 500 px. You can either enter a value relative to your `BaseURL`, or a fully qualified URL. If you want to use the default, set this to `""`. Optional. If left blank, or not existent, a default image will be provided. You can replace this default image by putting a new 500 px x 500 px PNG image at `/static/img/guest/default-guest.png` in your site (not in the theme!). Please ensure that this path does NOT start with `/` | "img/guest/jane-smith.png" | +| `Website` | No | The guest's website. Be use to includ http(s) at the beginning. | "https://www.mattstratton.com" | +| `GitHub` | No | Guest's GitHub username. | "mattstratton" | +| `Facebook` | No | Guest's Facebook username. Do not use the full URL. | "matt.stratton" | +| `Twitter` | No | Guest's Twitter username, without the `@`. | "mattstratton" | +| `LinkedIn` | No | LinkedIn profile name. Optional. This is the part that comes after the `https://www.linkedin.com/in/` in your profile URL. | "mattstratton" | | |