diff options
| author | Matt Stratton <matt.stratton@gmail.com> | 2017-05-19 21:51:22 +0300 |
|---|---|---|
| committer | Matt Stratton <matt.stratton@gmail.com> | 2017-05-19 21:51:22 +0300 |
| commit | 7de4c388d30c7c0a2c2ed8fa5f16ff7a15045cd9 (patch) | |
| tree | 7617ad2c50c86e87da4b2acd60d9d9809274363c /README.md | |
| parent | c83efe961f9e2bb3d4a67b8718ed934f65dc99e0 (diff) | |
Update README with tables
Fixes #49
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 143 |
1 files changed, 90 insertions, 53 deletions
@@ -39,62 +39,99 @@ After installing Castanet successfully it requires a just a few more steps to ge You will need to add a handful of configuration items to your `config.toml` file. You can take a look at the [example site](https://github.com/mattstratton/castanet/blob/master/exampleSite/config.toml) to see them in action. They are described below: +#### Top-level items + + + - `googleAnalytics` - the Google Analytics tracking ID. We use the async method. Example: `"UA-123-45"` - `disqusShortname` - the shortname for use in Disqus comments. Example: `"arresteddevops"`. Note: The Disqus comments will not appear if you are running on `localhost`. -- `[params]` - - `site_theme` - the color scheme for the overall site. Currently the options are `orange`, `grey`, and `blue`. Optional. Example: `"blue"`. Defaults to the `orange` theme if not set. - - `site_layout` - the layout to use. The optiions are `grid` or `row`. Optional. Example `"grid"`. - - `enable_jumbo` - When using the `row` layout, will set a jumbotron at the top intead of the sidebar. Optional. Can be "true" or "false". - - `custom_css` - array of custom CSS files for over-riding theme settings or adding your own classes. Example: `["custom.css", "other_custom.css"]`. These files should be put into your `static` directory (not the `static` directory of the theme). - - `about_logo` - the logo (250px x 250px) you would like to appear on your About page. Optional. If not set, this will default to your iTunes image. - - `copyright_notice` - Your copyright information for the footer of the page. Can contain Markdown. Example: `"Copyright 2016 [Matt Stratton](https://www.mattstrattion.io)"` - - `itunes_subscribe` - The URL of your podcast in the iTunes store. Optional. Example: `"http://itunes.apple.com/us/podcast/arrested-devops/id773888088?mt=2&uo=4&at=11lsCi"` - - `android_subscribe` - The URL for your podcast for Android users. You can generate this URL at [Subscribe on Android](https://subscribeonandroid.com). Optional. Example: ``"http://subscribeonandroid.com/feeds.podtrac.com/VGAulpN7MY1U"`` - - `google_play_subscribe` The URL to your podcast in the Google Play store. Optional. Example: `"https://goo.gl/app/playmusic?ibi=com.google.PlayMusic&isi=691797987&ius=googleplaymusic&link=https://play.google.com/music/m/Ihj4yege3lfmp3vs5yoopgxijpi?t%3DArrested_DevOps"` - - `sticher_subscribe` The URL to your podcast on Stitcher. Optional. Example: `"hhttp://www.stitcher.com/podcast/arrested-devops-2/arrested-devops"` - - `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"` - - `itunes_author` - The author name for your show. No Markdown or HTML. Example: `"Matt Stratton"` - - `itunes_summary` Limited to 4000 characters or less, plain text, no HTML. Example: `"The HugoCast is the best podcast you've ever seen. You will learn everything you ever needed to know about podcasting from the most inspiring experts to ever show up on the whole internet."` - - `itunes_owner_name` = The name associated with the owner of the podcast on iTunes. Will not be displayed publiclly on iTunes. Example: `"Matt Stratton"` - - `itunes_owner_email` - The e-mail address that will be used to contact the owner of the Podcast for communication specifically about their podcast on iTunes. It will not be publicly displayed on iTunes. Example: `"your.name@gmail.com"` - - `itunes_image` - Fully qualified path to your podcast's artwork for iTunes. `"https://www.arresteddevops.com/img/ado-podcast-logo.png"` - - `itunes_top_category` = `"Technology"` - - `itunes_first_sub_category` = `"Software How-To`" - - `itunes_second_sub_categor`y = `"Tech News"` - - - `[params.social]` - - `github` - GitHub username only. Optional. Example: `"mattstratton"` - - `facebook` - Name of the Facebook page (not the URL). Optional. Example: `"Arresteddevops"` - - `facebook_admin` - Optional. This needs to be a page admin to get domain insights. Example: `"500557137"` - - `twitter` - Twitter name without the `@` sign. Optional. Example: `"mattstratton"` - - `twitter_domain` - This domain shows in twitter cards as "View on `twitter_domain`" Example: `"arresteddevops.com"` - - `googleplus` - Google Plus page name, without the `+`. Optional. Example: `"ArrestedDevOps"` - - `pinterest` - Optional. Example: `"nozzleio"` - - `instagram` - Optional. Example: `"nozzleio"` - - `youtube` - Name of the YouTube channel. Optional. Example: `"arresteddevops"` - - `linkedin` - LinkedIn profile name. Optional. This is the part that comes after the `https://www.linkedin.com/in/` in your profile URL. Example: `"mattstratton"` - - - `[params.authors]` - you can have multiple authors avaialable; just make more of each - - `[params.authors.USERNAME]` - replace `USERNAME` with an author name. Example: `[params.authors.matt]` - - `name` - Example: `"Matt Stratton"` - - `thumbnail` - URL to user's image. Example: `"https://www.arresteddevops.com/img/matt.png"` - - `bio` - Author's bio. Example: `"Matt Stratton is a solutions architect at Chef, where he demonstrates how Chef’s automation platform provides speed and flexibility to clients’ infrastructure. He is devoted to concepts like Continuous Delivery and Infrastructure as Code, and his license plate actually says “DevOps”. He lives in Chicago and has an unhealthy obsession with Doctor Who, Firefly, and Game of Thrones. And whiskey."` - - `[params.authors.USERNAME.social]` - social networking parameters for the author - - `github` - Example: `"mattstratton"` - - `facebook` - Example: `"matt.stratton"` - - `twitter` - Example: `mattstratton` - - `linkedin` - Example: `"mattstratton"` - - `homepage` - Example: `"https://www.mattstratton.com"` - - `pinterest` - Example: `"mattstratton"` - - `instagram` - Example: `"mattstratton"` - - `youtube` - Example: `"mattstratton"` +#### General Parameters + +These should be set under the `[params]` section: + +| Field Name | Required | Description | Example | +|-------------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `site_theme` | No | The color scheme for the overall site. Currently the options are `orange` (default), `grey`, and `blue`. | "blue" | +| `site_layout` | No | The layout for the home page. The options are `row` (default) or `grid`. | "grid" | +| `enable_jumbo` | No | When using the `row` layout, will set a jumbotron at the top instead of the sidebar. | "true" | +| `custom_css` | No | Array of custom CSS files for over-riding theme settings or adding your own classes. These files should be put into your `static` directory (not the `static` directory of the theme). | ["custom.css", "other_custom.css"] | +| `about_logo` | No | The logo (250px x 250px) you would like to appear on your About page. If not set, this will default to your iTunes image. This path should be relative to your main URL, for example, a file put in your `static` directory. This path should not start with a `/`. | "img/my_logo.png" | +| `copyright_notice` | Yes | Your copyright information for the footer of the page. Can contain Markdown. | `"Copyright 2016 [Matt Stratton](https://www.mattstrattion.io)"` | +| `itunes_subscribe` | No | The URL of your podcast in the iTunes store. | "http://itunes.apple.com/us/podcast/arrested-devops/id773888088?mt=2&uo=4&at=11lsCi" | +| `android_subscribe` | No | The URL for your podcast for Android users. You can generate this URL at [Subscribe on Android](https://subscribeonandroid.com). | "http://subscribeonandroid.com/feeds.podtrac.com/VGAulpN7MY1U" | +| `google_play_subscribe` | No | The URL to your podcast in the Google Play store. | "https://goo.gl/app/playmusic?ibi=com.google.PlayMusic&isi=691797987&ius=googleplaymusic&link=https://play.google.com/music/m/Ihj4yege3lfmp3vs5yoopgxijpi?t%3DArrested_DevOps" | +| `sticher_subscribe` | No | The URL to your podcast on Stitcher. | "http://www.stitcher.com/podcast/arrested-devops-2/arrested-devops" | +| `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."` | +| `media_prefix` | Yes | The URL to pre-pend to your podcast files. Must end in a slash. | "https://media.blubrry.com/arresteddevops/content.blubrry.com/arresteddevops/" | + +#### Feed Parameters + +These should be set under `[params.feed]` + +| Field Name | Required | Description | Example | +|------------------------------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `feed_copyright` | Yes | The copyright information for your feed. Do not use Markdown. | "Copyright 2017 Matt Stratton" | +| `itunes_subtitle` | No | No Markdown or HTML. | "The best podcast ever" | +| `itunes_author` | Yes | The author name for your show. No Markdown or HTML. | "Matt Stratton" | +| `itunes_summary` | Yes | Limited to 4000 characters or less, plain text, no HTML. | "The HugoCast is the best podcast you've ever seen. You will learn everything you ever needed to know about podcasting from the most inspiring experts to ever show up on the whole internet." | +| `itunes_owner_name` | Yes | The name associated with the owner of the podcast on iTunes. Will not be displayed publicly on iTunes. | "Matt Stratton" | +| `itunes_owner_email` | Yes | The e-mail address that will be used to contact the owner of the podcast for communication specifically about their podcast on iTunes. It will not be publicly displayed on iTunes. | "your.name@gmail.com" | +| `itunes_image` | Yes | Fully qualified path to your podcast's artwork for iTunes. | "https://www.arresteddevops.com/img/ado-podcast-logo.png" | +| `itunes_top_category` | Yes | The main category for your podcast in iTunes | "Technology" | +| `itunes_first_sub_category` | No | The first sub-category for your podcast in iTunes | "Software How-To" | +| `itunes_second_sub_category` | No | The second sub-category for your podcast in iTunes. Do not set this if you didn't set the first one. | "Tech News" | + +#### Social Parameters + +These are the social network parameters for your overall site. They should be set under `[params.social]` + +| Field Name | Required | Description | Example | +|------------------|----------|------------------------------------------------------------------------------------------------------------------|----------------------| +| `github` | No | GitHub username only. | "mattstratton" | +| `facebook` | No | Name of the Facebook page (not the URL). | "Arresteddevops" | +| `facebook_admin` | No | This needs to be a page admin to get domain insights. | "500557137" | +| `twitter` | No | Twitter name without the `@` sign. | "arresteddevops" | +| `twitter_domain` | Yes | This domain shows in twitter cards as "View on `twitter_domain`". | "arresteddevops.com" | +| `googleplus` | No | Google Plus page name, without the `+`. | "ArrestedDevOps" | +| `pinterest` | No | Pinterest username. | "nozzleio" | +| `instagram` | No | Instagram username. | "nozzleio" | +| `youtube` | No | Name of the YouTube channel. | "arresteddevops" | +| `linkedin` | No | LinkedIn profile name. This is the part that comes after the `https://www.linkedin.com/in/` in your profile URL. | "mattstratton" | + +#### Host/Author Parameters + +We use the "authors" from the configuration to list hosts as well. All hosts should have an entry in here. These settings should be set under `[params.authors]` and then `[params.authors.USERNAME]` for each host, for example: + +``` +[params.authors] + [params.authors.Matt] + name = "Matt Stratton" +``` + +| Field Name | Required | Description | Example | +|-------------|----------|-----------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `name` | Yes | The full name of the author/host. | "Matt Stratton" | +| `thumbnail` | Yes | The image for the user. This can either be a fully qualifed URL, or relative to the baseURL. | "http://www.arresteddevops.com/matt.png" or "img/hosts/matt.png" | +| `bio` | Yes | The author/host bio. Supports Markdown. | "Matt Stratton is a solutions architect at Chef, where he demonstrates how Chef’s automation platform provides speed and flexibility to clients’ infrastructure. He is devoted to concepts like Continuous Delivery and Infrastructure as Code, and his license plate actually says “DevOps”. He lives in Chicago and has an unhealthy obsession with Doctor Who, Firefly, and Game of Thrones. And whiskey." | + +##### Host Social Parameters + +You also will set the social parameters (all are optional) under `[params.authors.USERNAME.social]` + +| Field Name | Required | Description | Example | +|-------------|----------|------------------------------------------------------------------------------------------------------------------|--------------------------------| +| `github` | No | GitHub username only. | "mattstratton" | +| `facebook` | No | Name of the user's Facebook page (not the URL). | "matt.stratton" | +| `twitter` | No | Twitter name without the `@` sign. | "mattstratton | +| `pinterest` | No | Pinterest username. | "nozzleio" | +| `instagram` | No | Instagram username. | "nozzleio" | +| `youtube` | No | Name of the user's YouTube profile. | mattstratton | +| `linkedin` | No | LinkedIn profile name. This is the part that comes after the `https://www.linkedin.com/in/` in your profile URL. | "mattstratton" | +| `homepage` | No | The user's website, including the `http` at the beginning. | "https://www.mattstratton.com" | + #### A note about `BaseURL` |