akashacms-blog-podcast
Advanced tools
akashacms-blog-podcast - npm Package Compare versions
Comparing version 0.7.2 to 0.7.3
@@ -39,6 +39,10 @@ --- | ||
| ``` | ||
| ```js | ||
| config | ||
| ... | ||
| .use(require('akashacms-blog-podcast')) | ||
| .use(require('akashacms-blog-podcast'), { | ||
| bloglist: { | ||
| // blog definitions | ||
| } | ||
| }) | ||
| ... | ||
@@ -61,29 +65,40 @@ ``` | ||
| ``` | ||
| config.plugin('akashacms-blog-podcast') | ||
| .addBlogPodcast(config, "news", { | ||
| rss: { | ||
| title: "AkashaCMS Example Blog", | ||
| description: "Skeleton blog for use with AkashaCMS", | ||
| site_url: "http://blog-skeleton.akashacms.com/blog/index.html", | ||
| image_url: "http://akashacms.com/logo.gif", | ||
| managingEditor: 'David Herron', | ||
| webMaster: 'David Herron', | ||
| copyright: '2015 David Herron', | ||
| language: 'en', | ||
| categories: [ "Node.js", "Content Management System", "HTML5", "Static website generator" ] | ||
| }, | ||
| rssurl: "/blog/rss.xml", | ||
| rootPath: "blog", | ||
| matchers: { | ||
| layouts: [ "blog.html.ejs" ], | ||
| path: /^blog\// | ||
| ```js | ||
| config | ||
| ... | ||
| .use(require('akashacms-blog-podcast'), { | ||
| bloglist: { | ||
| news: { | ||
| rss: { | ||
| title: "AkashaCMS Example Blog", | ||
| description: "Skeleton blog for use with AkashaCMS", | ||
| site_url: "http://blog-skeleton.akashacms.com/blog/index.html", | ||
| image_url: "http://akashacms.com/logo.gif", | ||
| managingEditor: 'David Herron', | ||
| webMaster: 'David Herron', | ||
| copyright: '2015 David Herron', | ||
| language: 'en', | ||
| categories: [ "Node.js", "Content Management System", "HTML5", "Static website generator" ] | ||
| }, | ||
| rssurl: "/blog/rss.xml", | ||
| rootPath: "blog", | ||
| matchers: { | ||
| layouts: [ "blog.html.ejs" ], | ||
| path: /^blog\// | ||
| } | ||
| } | ||
| } | ||
| }); | ||
| }) | ||
| ``` | ||
| With `config.plugin('akashacms-blog-podcast')` we access the Plugin instance object so we can call the `addBlogPodcast` function. As the name implies, this adds another Blog/Podcast to the site. | ||
| The `options` object for `akashacms-blog-podcast` is the list of blogs to be configured for this website. The `bloglist` object contains entries where the _key_ (in this case `news`) is the _blogtag_, and the value is the configuration for the blog. | ||
| The first argument is the `config` object, and the second is the `blogtag`. That string is used in several places to identify which blog instance is being referenced. The last argument is an object describing the blog instance. | ||
| The _blogtag_ can be thought of as a short name for the blog. It is used in several places, such as in the header of articles that are part of the blog. A document will have this header to identify which blog it is part of: | ||
| ```yaml | ||
| blogtag: news | ||
| ``` | ||
| As we said, the content of this object describes the blog. | ||
| The `rss` field contains several entries describing the RSS metadata. This object is passed directly to the `rss` module, see its documentation for more details: https://www.npmjs.com/package/rss Notice that it's relatively easy to define the metadata required for a podcast using that module. | ||
@@ -110,3 +125,3 @@ | ||
| ``` | ||
| ```yaml | ||
| --- | ||
@@ -131,3 +146,3 @@ layout: blog.html.ejs | ||
| ``` | ||
| ```html | ||
| <div class="row"> | ||
@@ -142,3 +157,3 @@ <section id="breadcrumb" class="col-sm-12"> | ||
| ``` | ||
| ```html | ||
| <div class="row"> | ||
@@ -155,3 +170,3 @@ <section id="category-tags" class="col-sm-12"> | ||
| ``` | ||
| ```html | ||
| <section id="right" class="col-sm-2"> | ||
@@ -165,3 +180,3 @@ <tag-cloud/> | ||
| ``` | ||
| ```html | ||
| <blog-next-prev></blog-next-prev> | ||
@@ -174,3 +189,3 @@ ``` | ||
| ``` | ||
| ```html | ||
| <partial file-name='disqus.html'></partial> | ||
@@ -187,3 +202,3 @@ ``` | ||
| ``` | ||
| ```html | ||
| <blog-news-river maxentries="100"></blog-news-river> | ||
@@ -198,3 +213,3 @@ ``` | ||
| ``` | ||
| ```html | ||
| <blog-rss-icon></blog-rss-icon> | ||
@@ -213,3 +228,3 @@ ``` | ||
| ``` | ||
| ```html | ||
| <div id="blog-1-news"> | ||
@@ -216,0 +231,0 @@ <div class="well well-sm"><h2>Blog #1</h2></div> |
@@ -41,3 +41,3 @@ /** | ||
| config.addMahabhuta(module.exports.mahabhutaArray(options)); | ||
| options.bloglist = []; | ||
| if (!options.bloglist) options.bloglist = []; | ||
| } | ||
@@ -44,0 +44,0 @@ |
@@ -14,3 +14,3 @@ { | ||
| }, | ||
| "version": "0.7.2", | ||
| "version": "0.7.3", | ||
| "engines": { | ||
@@ -17,0 +17,0 @@ "node": ">=12.2" |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by1.41%
32663