{"action":"created","comment":{"url":"https://api.github.com/repos/metalsmith/metalsmith/pulls/comments/84562239","pull_request_review_id":5336409,"id":84562239,"diff_hunk":"@@ -0,0 +1,179 @@\n+\n+# RSS Feed Example\n+\n+This example uses Metalsmith to create a static site and implements an rss feed of all your posts using the metalsmith-feed and metalsmith-collections plugins. \n+\n+## Install Node and Update NPM \n+\n+You should have npm and node installed. If you do not have these installed you can download and install Node.js via the installer from [here](https://nodejs.org/en/download/). Once the installer is completed you must update npm. Update npm by opening up your bash client and running the line below:\n+\n+\t$ npm install npm@latest -g\n+\n+##Setting Up Your Project\n+\n+Let's create a directory for this project and cd into it. Navigate to the folder where you usually place all your projects. In your favorite bash client make the projects directory, I'm going to name mine `rss-feed-example`. \n+\n+\t$ mkdir rss-feed-example\n+\n+Now that the directory is created, I'm going to open it up with\n+\n+\t$ cd rss-feed-example\n+\n+##Creating and Running your package.json file \n+\n+Once your in the projects directory, create a file called `package.json`. The `package.json` file will have information relative to your project and is necessary for npm to install different tools and modules that will help you while building your project. The contents of your `package.json` should look like this. \n+\n+\t{\n+  \t\t\"name\": \"rss-feed-example\",\n+\t\t\"version\": \"1.0.0\",\n+\t\t\"dependencies\": {\n+\t\t    \"handlebars\": \"^4.0.5\",\n+\t\t    \"metalsmith\": \"^2.1.0\",\n+\t\t    \"metalsmith-layouts\": \"^1.4.1\",\n+\t\t    \"metalsmith-markdown\": \"^0.2.1\",\n+\t\t    \"metalsmith-permalinks\": \"^0.5.0\",\n+\t\t\t\"metalsmith-collections\": \"^0.7.0\",\n+\t\t\t\"metalsmith-feed\": \"^0.2.0\"\t\n+\t\t}\n+\t}\n+\n+Let's go through the fields in this file. \n+\n+1. The name field is the name of your project and is required.\n+2. The version number is the version number of your project and is required.\n+3. Dependencies are the dependencies the project will use.\n+4. handlebars will enable handlebars templating to be used in our project. \n+5. metalsmith allows metalsmith to be used in our project \n+6. metalsmith-layouts helps us generate templates in conjunction with handlebars. \n+7. metalsmith-markdown enables markdown files to be compiled into html files.\n+8. metalsmith-permalinks will prettify our urls and nest our subdirectories to make them more managable. \n+9. metalsmith-collection helps us group different files and iterate over these files in other places in our project.\n+10. metalsmit-feed will generate the rss feed for us based on our metalsmith-collection plugin options.\n+\n+Now that we have created our package.json, file let's run it. If npm completes the installation with no errors you should see a new folder in the directory named `node-modules`, which will have all the dependencies we listed in the `package.json` file. \n+\n+\t$ npm install\n+\n+##Creating Our index.js file\n+\n+Lets create a simple index.js file in our projects root directory. The file should look like this: \n+\n+\tvar Metalsmith  = require('metalsmith');\n+\tvar markdown    = require('metalsmith-markdown');\n+\tvar layouts     = require('metalsmith-layouts');\n+\tvar permalinks  = require('metalsmith-permalinks');\n+\tvar collections = require('metalsmith-collections');\n+\tvar feed        = require('metalsmith-feed');\n+\n+\n+\tMetalsmith(__dirname)\n+\t  .metadata({\n+\t    title: \"RSS Feed Example\",\n+\t    description: \"It's about saying »Hello« to the World and letting the world keep up with your blog via RSS feed.\",\n+\t    generator: \"Metalsmith\",\n+\t    url: \"http://www.metalsmith.io/\",\n+\t    site:{\n+\t      title: \"RSS Feed Example\",\n+\t      url: \"http://www.metalsmith.io/\",\n+\t      author: \"George RR Martin\"\n+\t    }\n+\t  })\n+\t  .source('./src')\n+\t  .destination('./build')\n+\t  .clean(false)","path":"examples/rss-feed/Readme.md","position":83,"original_position":83,"commit_id":"e045ef51815662a85d3c9712f0250effa1f99e12","original_commit_id":"e045ef51815662a85d3c9712f0250effa1f99e12","user":{"login":"rjm226","id":6422764,"avatar_url":"https://avatars.githubusercontent.com/u/6422764?v=3","gravatar_id":"","url":"https://api.github.com/users/rjm226","html_url":"https://github.com/rjm226","followers_url":"https://api.github.com/users/rjm226/followers","following_url":"https://api.github.com/users/rjm226/following{/other_user}","gists_url":"https://api.github.com/users/rjm226/gists{/gist_id}","starred_url":"https://api.github.com/users/rjm226/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/rjm226/subscriptions","organizations_url":"https://api.github.com/users/rjm226/orgs","repos_url":"https://api.github.com/users/rjm226/repos","events_url":"https://api.github.com/users/rjm226/events{/privacy}","received_events_url":"https://api.github.com/users/rjm226/received_events","type":"User","site_admin":false},"body":"In this example clean doesn't really do anything. I had been making a lot of PR's last week and copied a bunch of code for this PR. We can get rid of clean. ","created_at":"2016-10-21T23:49:00Z","updated_at":"2016-10-21T23:49:00Z","html_url":"https://github.com/metalsmith/metalsmith/pull/255#discussion_r84562239","pull_request_url":"https://api.github.com/repos/metalsmith/metalsmith/pulls/255","_links":{"self":{"href":"https://api.github.com/repos/metalsmith/metalsmith/pulls/comments/84562239"},"html":{"href":"https://github.com/metalsmith/metalsmith/pull/255#discussion_r84562239"},"pull_request":{"href":"https://api.github.com/repos/metalsmith/metalsmith/pulls/255"}}},"pull_request":{"url":"https://api.github.com/repos/metalsmith/metalsmith/pulls/255","id":88875308,"html_url":"https://github.com/metalsmith/metalsmith/pull/255","diff_url":"https://github.com/metalsmith/metalsmith/pull/255.diff","patch_url":"https://github.com/metalsmith/metalsmith/pull/255.patch","issue_url":"https://api.github.com/repos/metalsmith/metalsmith/issues/255","number":255,"state":"open","locked":false,"title":"Sample RSS Feed","user":{"login":"rjm226","id":6422764,"avatar_url":"https://avatars.githubusercontent.com/u/6422764?v=3","gravatar_id":"","url":"https://api.github.com/users/rjm226","html_url":"https://github.com/rjm226","followers_url":"https://api.github.com/users/rjm226/followers","following_url":"https://api.github.com/users/rjm226/following{/other_user}","gists_url":"https://api.github.com/users/rjm226/gists{/gist_id}","starred_url":"https://api.github.com/users/rjm226/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/rjm226/subscriptions","organizations_url":"https://api.github.com/users/rjm226/orgs","repos_url":"https://api.github.com/users/rjm226/repos","events_url":"https://api.github.com/users/rjm226/events{/privacy}","received_events_url":"https://api.github.com/users/rjm226/received_events","type":"User","site_admin":false},"body":"Created an RSS Feed example. Thought this would help others looking to create an RSS Feed for a static blog they were looking to create with Metalsmith. Something I needed. ","created_at":"2016-10-11T17:27:20Z","updated_at":"2016-10-21T23:49:00Z","closed_at":null,"merged_at":null,"merge_commit_sha":"7d89605a9bf5eb4cdd02f0bd511e36a638612aa4","assignee":null,"assignees":[],"milestone":null,"commits_url":"https://api.github.com/repos/metalsmith/metalsmith/pulls/255/commits","review_comments_url":"https://api.github.com/repos/metalsmith/metalsmith/pulls/255/comments","review_comment_url":"https://api.github.com/repos/metalsmith/metalsmith/pulls/comments{/number}","comments_url":"https://api.github.com/repos/metalsmith/metalsmith/issues/255/comments","statuses_url":"https://api.github.com/repos/metalsmith/metalsmith/statuses/e045ef51815662a85d3c9712f0250effa1f99e12","head":{"label":"rjm226:sample-rss-feed","ref":"sample-rss-feed","sha":"e045ef51815662a85d3c9712f0250effa1f99e12","user":{"login":"rjm226","id":6422764,"avatar_url":"https://avatars.githubusercontent.com/u/6422764?v=3","gravatar_id":"","url":"https://api.github.com/users/rjm226","html_url":"https://github.com/rjm226","followers_url":"https://api.github.com/users/rjm226/followers","following_url":"https://api.github.com/users/rjm226/following{/other_user}","gists_url":"https://api.github.com/users/rjm226/gists{/gist_id}","starred_url":"https://api.github.com/users/rjm226/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/rjm226/subscriptions","organizations_url":"https://api.github.com/users/rjm226/orgs","repos_url":"https://api.github.com/users/rjm226/repos","events_url":"https://api.github.com/users/rjm226/events{/privacy}","received_events_url":"https://api.github.com/users/rjm226/received_events","type":"User","site_admin":false},"repo":{"id":69752494,"name":"metalsmith","full_name":"rjm226/metalsmith","owner":{"login":"rjm226","id":6422764,"avatar_url":"https://avatars.githubusercontent.com/u/6422764?v=3","gravatar_id":"","url":"https://api.github.com/users/rjm226","html_url":"https://github.com/rjm226","followers_url":"https://api.github.com/users/rjm226/followers","following_url":"https://api.github.com/users/rjm226/following{/other_user}","gists_url":"https://api.github.com/users/rjm226/gists{/gist_id}","starred_url":"https://api.github.com/users/rjm226/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/rjm226/subscriptions","organizations_url":"https://api.github.com/users/rjm226/orgs","repos_url":"https://api.github.com/users/rjm226/repos","events_url":"https://api.github.com/users/rjm226/events{/privacy}","received_events_url":"https://api.github.com/users/rjm226/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/rjm226/metalsmith","description":"An extremely simple, pluggable static site generator.","fork":true,"url":"https://api.github.com/repos/rjm226/metalsmith","forks_url":"https://api.github.com/repos/rjm226/metalsmith/forks","keys_url":"https://api.github.com/repos/rjm226/metalsmith/keys{/key_id}","collaborators_url":"https://api.github.com/repos/rjm226/metalsmith/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/rjm226/metalsmith/teams","hooks_url":"https://api.github.com/repos/rjm226/metalsmith/hooks","issue_events_url":"https://api.github.com/repos/rjm226/metalsmith/issues/events{/number}","events_url":"https://api.github.com/repos/rjm226/metalsmith/events","assignees_url":"https://api.github.com/repos/rjm226/metalsmith/assignees{/user}","branches_url":"https://api.github.com/repos/rjm226/metalsmith/branches{/branch}","tags_url":"https://api.github.com/repos/rjm226/metalsmith/tags","blobs_url":"https://api.github.com/repos/rjm226/metalsmith/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/rjm226/metalsmith/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/rjm226/metalsmith/git/refs{/sha}","trees_url":"https://api.github.com/repos/rjm226/metalsmith/git/trees{/sha}","statuses_url":"https://api.github.com/repos/rjm226/metalsmith/statuses/{sha}","languages_url":"https://api.github.com/repos/rjm226/metalsmith/languages","stargazers_url":"https://api.github.com/repos/rjm226/metalsmith/stargazers","contributors_url":"https://api.github.com/repos/rjm226/metalsmith/contributors","subscribers_url":"https://api.github.com/repos/rjm226/metalsmith/subscribers","subscription_url":"https://api.github.com/repos/rjm226/metalsmith/subscription","commits_url":"https://api.github.com/repos/rjm226/metalsmith/commits{/sha}","git_commits_url":"https://api.github.com/repos/rjm226/metalsmith/git/commits{/sha}","comments_url":"https://api.github.com/repos/rjm226/metalsmith/comments{/number}","issue_comment_url":"https://api.github.com/repos/rjm226/metalsmith/issues/comments{/number}","contents_url":"https://api.github.com/repos/rjm226/metalsmith/contents/{+path}","compare_url":"https://api.github.com/repos/rjm226/metalsmith/compare/{base}...{head}","merges_url":"https://api.github.com/repos/rjm226/metalsmith/merges","archive_url":"https://api.github.com/repos/rjm226/metalsmith/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/rjm226/metalsmith/downloads","issues_url":"https://api.github.com/repos/rjm226/metalsmith/issues{/number}","pulls_url":"https://api.github.com/repos/rjm226/metalsmith/pulls{/number}","milestones_url":"https://api.github.com/repos/rjm226/metalsmith/milestones{/number}","notifications_url":"https://api.github.com/repos/rjm226/metalsmith/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/rjm226/metalsmith/labels{/name}","releases_url":"https://api.github.com/repos/rjm226/metalsmith/releases{/id}","deployments_url":"https://api.github.com/repos/rjm226/metalsmith/deployments","created_at":"2016-10-01T17:23:32Z","updated_at":"2016-10-01T17:23:34Z","pushed_at":"2016-10-11T17:32:17Z","git_url":"git://github.com/rjm226/metalsmith.git","ssh_url":"git@github.com:rjm226/metalsmith.git","clone_url":"https://github.com/rjm226/metalsmith.git","svn_url":"https://github.com/rjm226/metalsmith","homepage":"http://metalsmith.io","size":2366,"stargazers_count":0,"watchers_count":0,"language":"JavaScript","has_issues":false,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":0,"forks":0,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"metalsmith:master","ref":"master","sha":"1ceb80b04b30304fa9f8e6cd8a46421ca7305d26","user":{"login":"metalsmith","id":16531417,"avatar_url":"https://avatars.githubusercontent.com/u/16531417?v=3","gravatar_id":"","url":"https://api.github.com/users/metalsmith","html_url":"https://github.com/metalsmith","followers_url":"https://api.github.com/users/metalsmith/followers","following_url":"https://api.github.com/users/metalsmith/following{/other_user}","gists_url":"https://api.github.com/users/metalsmith/gists{/gist_id}","starred_url":"https://api.github.com/users/metalsmith/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/metalsmith/subscriptions","organizations_url":"https://api.github.com/users/metalsmith/orgs","repos_url":"https://api.github.com/users/metalsmith/repos","events_url":"https://api.github.com/users/metalsmith/events{/privacy}","received_events_url":"https://api.github.com/users/metalsmith/received_events","type":"Organization","site_admin":false},"repo":{"id":16501535,"name":"metalsmith","full_name":"metalsmith/metalsmith","owner":{"login":"metalsmith","id":16531417,"avatar_url":"https://avatars.githubusercontent.com/u/16531417?v=3","gravatar_id":"","url":"https://api.github.com/users/metalsmith","html_url":"https://github.com/metalsmith","followers_url":"https://api.github.com/users/metalsmith/followers","following_url":"https://api.github.com/users/metalsmith/following{/other_user}","gists_url":"https://api.github.com/users/metalsmith/gists{/gist_id}","starred_url":"https://api.github.com/users/metalsmith/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/metalsmith/subscriptions","organizations_url":"https://api.github.com/users/metalsmith/orgs","repos_url":"https://api.github.com/users/metalsmith/repos","events_url":"https://api.github.com/users/metalsmith/events{/privacy}","received_events_url":"https://api.github.com/users/metalsmith/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/metalsmith/metalsmith","description":"An extremely simple, pluggable static site generator.","fork":false,"url":"https://api.github.com/repos/metalsmith/metalsmith","forks_url":"https://api.github.com/repos/metalsmith/metalsmith/forks","keys_url":"https://api.github.com/repos/metalsmith/metalsmith/keys{/key_id}","collaborators_url":"https://api.github.com/repos/metalsmith/metalsmith/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/metalsmith/metalsmith/teams","hooks_url":"https://api.github.com/repos/metalsmith/metalsmith/hooks","issue_events_url":"https://api.github.com/repos/metalsmith/metalsmith/issues/events{/number}","events_url":"https://api.github.com/repos/metalsmith/metalsmith/events","assignees_url":"https://api.github.com/repos/metalsmith/metalsmith/assignees{/user}","branches_url":"https://api.github.com/repos/metalsmith/metalsmith/branches{/branch}","tags_url":"https://api.github.com/repos/metalsmith/metalsmith/tags","blobs_url":"https://api.github.com/repos/metalsmith/metalsmith/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/metalsmith/metalsmith/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/metalsmith/metalsmith/git/refs{/sha}","trees_url":"https://api.github.com/repos/metalsmith/metalsmith/git/trees{/sha}","statuses_url":"https://api.github.com/repos/metalsmith/metalsmith/statuses/{sha}","languages_url":"https://api.github.com/repos/metalsmith/metalsmith/languages","stargazers_url":"https://api.github.com/repos/metalsmith/metalsmith/stargazers","contributors_url":"https://api.github.com/repos/metalsmith/metalsmith/contributors","subscribers_url":"https://api.github.com/repos/metalsmith/metalsmith/subscribers","subscription_url":"https://api.github.com/repos/metalsmith/metalsmith/subscription","commits_url":"https://api.github.com/repos/metalsmith/metalsmith/commits{/sha}","git_commits_url":"https://api.github.com/repos/metalsmith/metalsmith/git/commits{/sha}","comments_url":"https://api.github.com/repos/metalsmith/metalsmith/comments{/number}","issue_comment_url":"https://api.github.com/repos/metalsmith/metalsmith/issues/comments{/number}","contents_url":"https://api.github.com/repos/metalsmith/metalsmith/contents/{+path}","compare_url":"https://api.github.com/repos/metalsmith/metalsmith/compare/{base}...{head}","merges_url":"https://api.github.com/repos/metalsmith/metalsmith/merges","archive_url":"https://api.github.com/repos/metalsmith/metalsmith/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/metalsmith/metalsmith/downloads","issues_url":"https://api.github.com/repos/metalsmith/metalsmith/issues{/number}","pulls_url":"https://api.github.com/repos/metalsmith/metalsmith/pulls{/number}","milestones_url":"https://api.github.com/repos/metalsmith/metalsmith/milestones{/number}","notifications_url":"https://api.github.com/repos/metalsmith/metalsmith/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/metalsmith/metalsmith/labels{/name}","releases_url":"https://api.github.com/repos/metalsmith/metalsmith/releases{/id}","deployments_url":"https://api.github.com/repos/metalsmith/metalsmith/deployments","created_at":"2014-02-04T03:46:22Z","updated_at":"2016-10-21T22:08:00Z","pushed_at":"2016-10-19T15:06:20Z","git_url":"git://github.com/metalsmith/metalsmith.git","ssh_url":"git@github.com:metalsmith/metalsmith.git","clone_url":"https://github.com/metalsmith/metalsmith.git","svn_url":"https://github.com/metalsmith/metalsmith","homepage":"http://metalsmith.io","size":2771,"stargazers_count":5302,"watchers_count":5302,"language":"JavaScript","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":457,"mirror_url":null,"open_issues_count":43,"forks":457,"open_issues":43,"watchers":5302,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/metalsmith/metalsmith/pulls/255"},"html":{"href":"https://github.com/metalsmith/metalsmith/pull/255"},"issue":{"href":"https://api.github.com/repos/metalsmith/metalsmith/issues/255"},"comments":{"href":"https://api.github.com/repos/metalsmith/metalsmith/issues/255/comments"},"review_comments":{"href":"https://api.github.com/repos/metalsmith/metalsmith/pulls/255/comments"},"review_comment":{"href":"https://api.github.com/repos/metalsmith/metalsmith/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/metalsmith/metalsmith/pulls/255/commits"},"statuses":{"href":"https://api.github.com/repos/metalsmith/metalsmith/statuses/e045ef51815662a85d3c9712f0250effa1f99e12"}}}}
{"actor":{"display_login":"rjm226"}}