{"action":"created","comment":{"url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/pulls/comments/22998003","id":22998003,"diff_hunk":"@@ -9,6 +9,8 @@ SassDoc is doing quite a lot of things under the hood. In most cases, you won't\n \n <p class=\"note  note--info\"><strong>Clarification:</strong> in the following examples, we are using C-style comments but it works exactly the same for inline comments as well. Please refer to the <a href=\"/annotations/\">Annotations</a> page for the syntax.</p>\n \n+<p class=\"note  note--info\"><strong>Note:</strong>You can run SassDoc in parse mode with the <code>--parse</code> CLI flag to output the data as JSON instead of generating a documentation directory.</p>","path":"data-interface/index.md","position":4,"original_position":4,"commit_id":"822731b387187f21e4b1868d122ff3b1597d3c1c","original_commit_id":"822731b387187f21e4b1868d122ff3b1597d3c1c","user":{"login":"valeriangalliat","id":3929133,"avatar_url":"https://avatars.githubusercontent.com/u/3929133?v=3","gravatar_id":"","url":"https://api.github.com/users/valeriangalliat","html_url":"https://github.com/valeriangalliat","followers_url":"https://api.github.com/users/valeriangalliat/followers","following_url":"https://api.github.com/users/valeriangalliat/following{/other_user}","gists_url":"https://api.github.com/users/valeriangalliat/gists{/gist_id}","starred_url":"https://api.github.com/users/valeriangalliat/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/valeriangalliat/subscriptions","organizations_url":"https://api.github.com/users/valeriangalliat/orgs","repos_url":"https://api.github.com/users/valeriangalliat/repos","events_url":"https://api.github.com/users/valeriangalliat/events{/privacy}","received_events_url":"https://api.github.com/users/valeriangalliat/received_events","type":"User","site_admin":false},"body":"That was *also* the purpose of documentation. :smile_cat: ","created_at":"2015-01-15T09:24:12Z","updated_at":"2015-01-15T09:24:12Z","html_url":"https://github.com/SassDoc/sassdoc.github.io/pull/87#discussion_r22998003","pull_request_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/pulls/87","_links":{"self":{"href":"https://api.github.com/repos/SassDoc/sassdoc.github.io/pulls/comments/22998003"},"html":{"href":"https://github.com/SassDoc/sassdoc.github.io/pull/87#discussion_r22998003"},"pull_request":{"href":"https://api.github.com/repos/SassDoc/sassdoc.github.io/pulls/87"}}},"pull_request":{"url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/pulls/87","id":27194496,"html_url":"https://github.com/SassDoc/sassdoc.github.io/pull/87","diff_url":"https://github.com/SassDoc/sassdoc.github.io/pull/87.diff","patch_url":"https://github.com/SassDoc/sassdoc.github.io/pull/87.patch","issue_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/issues/87","number":87,"state":"open","locked":false,"title":"Style fixes & consistency, updates for 2.0","user":{"login":"valeriangalliat","id":3929133,"avatar_url":"https://avatars.githubusercontent.com/u/3929133?v=3","gravatar_id":"","url":"https://api.github.com/users/valeriangalliat","html_url":"https://github.com/valeriangalliat","followers_url":"https://api.github.com/users/valeriangalliat/followers","following_url":"https://api.github.com/users/valeriangalliat/following{/other_user}","gists_url":"https://api.github.com/users/valeriangalliat/gists{/gist_id}","starred_url":"https://api.github.com/users/valeriangalliat/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/valeriangalliat/subscriptions","organizations_url":"https://api.github.com/users/valeriangalliat/orgs","repos_url":"https://api.github.com/users/valeriangalliat/repos","events_url":"https://api.github.com/users/valeriangalliat/events{/privacy}","received_events_url":"https://api.github.com/users/valeriangalliat/received_events","type":"User","site_admin":false},"body":"\r\n* [x] Typography consistency.\r\n* [x] Configuration examples in YAML instead of JSON, except final JSON example.\r\n* [x] Data examples in JS, respecting our [guidelines](https://github.com/SassDoc/sassdoc/blob/develop/GUIDELINES.md).\r\n* [x] Update parts of the API examples to 2.0.\r\n* [x] Update documentation on how `package` and `theme` are resolved.\r\n* [x] Mention `--parse` flag on data interface page (can help people to see actual generated data and understand it).\r\n* [x] Remove mention to `--sass-convert`, update to new behavior.\r\n* [x] Ensure double spacing in HTML classes.\r\n* [x] Update part of theme page to Themeleon 3.0 behavior.\r\n* [x] `/configuration/#autofill`: list annotations that support autofill and how to configure it (do I include the `@` for example?).\r\n* Homepage:\r\n  * [x] \"so you end up with a fully styled HTML document, like this\"; update screenshot (still showing 1.0).\r\n  * [x] \"All these projects are built with SassDoc\"; \"are build with sassdoc\" sounds odd to me; the projects are not built with SassDoc, their documentation is built with SassDoc. Not sure it's necessary to distinguish, it's somehow obvious.\r\n* [x] `/gallery/` killed my PC, need to optimize (like use compressed images, and not in full size).\r\n* [x] `/gallery/`: ensure Bourbon Neat docs looks good by injecting custom CSS in webshot, to put a hard main content width (PhantomJS is really buggy with SVGs).\r\n* [x] Using your own theme is not linked too. It could be linked from configuration page \"these options are for default theme but you can use your own theme\", and in Getting started with \"`--theme` defaults to `default` but you can use your own theme\".\r\n* [x] Check if we need to update `generator-sassdoc-theme` and `sassdoc-theme-blank` for 2.0.\r\n* Using your own theme:\r\n  * [x] \"Note: you are not required to use Swig. Jade, Mustache, Nunjucks and Handlebars are also available\"; now everything is available through consolidate.js, need to change this sentence.\r\n  * [x] \"SassDoc will try to require the following until one matches\"; this is a duplicate with `/configuration/#theme`, maybe just link to it?\r\n  * [x] Update exemples with consolidate.js (meaning update `package.json` examples too, because the template engine has to be explicitely required).\r\n  * [x] Update Swig extras examples, because of consolidate.js the global Swig instance needs to be modified.\r\n  * [x] Link to the theme generator when speaking about it.\r\n* [x] `/node/`: mention stream usage, and say that's why it works out of the box in Gulp (and link to Gulp page).\r\n* <del>`/about/`: profile image for contributor could be an octopus, to stay in SassDoc style instead of the current neutral image.</del>\r\n* [x] Theme gallery is not linked anywhere. It could be linked near `--theme` option, and maybe in Using your own theme with \"you can inspirate from other themes\".\r\n* [x] `/getting-started/`: mention stdin/stdout CLI usage (without source argument).","created_at":"2015-01-12T13:43:36Z","updated_at":"2015-01-15T09:24:12Z","closed_at":null,"merged_at":null,"merge_commit_sha":"7bd441dfc45f1193e3b2bdb4aa87b440463611f0","assignee":{"login":"valeriangalliat","id":3929133,"avatar_url":"https://avatars.githubusercontent.com/u/3929133?v=3","gravatar_id":"","url":"https://api.github.com/users/valeriangalliat","html_url":"https://github.com/valeriangalliat","followers_url":"https://api.github.com/users/valeriangalliat/followers","following_url":"https://api.github.com/users/valeriangalliat/following{/other_user}","gists_url":"https://api.github.com/users/valeriangalliat/gists{/gist_id}","starred_url":"https://api.github.com/users/valeriangalliat/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/valeriangalliat/subscriptions","organizations_url":"https://api.github.com/users/valeriangalliat/orgs","repos_url":"https://api.github.com/users/valeriangalliat/repos","events_url":"https://api.github.com/users/valeriangalliat/events{/privacy}","received_events_url":"https://api.github.com/users/valeriangalliat/received_events","type":"User","site_admin":false},"milestone":{"url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/milestones/1","labels_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/milestones/1/labels","id":824273,"number":1,"title":"SassDoc 2.0","description":"","creator":{"login":"HugoGiraudel","id":1889710,"avatar_url":"https://avatars.githubusercontent.com/u/1889710?v=3","gravatar_id":"","url":"https://api.github.com/users/HugoGiraudel","html_url":"https://github.com/HugoGiraudel","followers_url":"https://api.github.com/users/HugoGiraudel/followers","following_url":"https://api.github.com/users/HugoGiraudel/following{/other_user}","gists_url":"https://api.github.com/users/HugoGiraudel/gists{/gist_id}","starred_url":"https://api.github.com/users/HugoGiraudel/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/HugoGiraudel/subscriptions","organizations_url":"https://api.github.com/users/HugoGiraudel/orgs","repos_url":"https://api.github.com/users/HugoGiraudel/repos","events_url":"https://api.github.com/users/HugoGiraudel/events{/privacy}","received_events_url":"https://api.github.com/users/HugoGiraudel/received_events","type":"User","site_admin":false},"open_issues":18,"closed_issues":6,"state":"open","created_at":"2014-10-13T17:14:39Z","updated_at":"2015-01-13T16:52:34Z","due_on":null,"closed_at":null},"commits_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/pulls/87/commits","review_comments_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/pulls/87/comments","review_comment_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/pulls/comments/{number}","comments_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/issues/87/comments","statuses_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/statuses/822731b387187f21e4b1868d122ff3b1597d3c1c","head":{"label":"SassDoc:update-doc","ref":"update-doc","sha":"822731b387187f21e4b1868d122ff3b1597d3c1c","user":{"login":"SassDoc","id":8111770,"avatar_url":"https://avatars.githubusercontent.com/u/8111770?v=3","gravatar_id":"","url":"https://api.github.com/users/SassDoc","html_url":"https://github.com/SassDoc","followers_url":"https://api.github.com/users/SassDoc/followers","following_url":"https://api.github.com/users/SassDoc/following{/other_user}","gists_url":"https://api.github.com/users/SassDoc/gists{/gist_id}","starred_url":"https://api.github.com/users/SassDoc/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/SassDoc/subscriptions","organizations_url":"https://api.github.com/users/SassDoc/orgs","repos_url":"https://api.github.com/users/SassDoc/repos","events_url":"https://api.github.com/users/SassDoc/events{/privacy}","received_events_url":"https://api.github.com/users/SassDoc/received_events","type":"Organization","site_admin":false},"repo":{"id":22545386,"name":"sassdoc.github.io","full_name":"SassDoc/sassdoc.github.io","owner":{"login":"SassDoc","id":8111770,"avatar_url":"https://avatars.githubusercontent.com/u/8111770?v=3","gravatar_id":"","url":"https://api.github.com/users/SassDoc","html_url":"https://github.com/SassDoc","followers_url":"https://api.github.com/users/SassDoc/followers","following_url":"https://api.github.com/users/SassDoc/following{/other_user}","gists_url":"https://api.github.com/users/SassDoc/gists{/gist_id}","starred_url":"https://api.github.com/users/SassDoc/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/SassDoc/subscriptions","organizations_url":"https://api.github.com/users/SassDoc/orgs","repos_url":"https://api.github.com/users/SassDoc/repos","events_url":"https://api.github.com/users/SassDoc/events{/privacy}","received_events_url":"https://api.github.com/users/SassDoc/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/SassDoc/sassdoc.github.io","description":"SassDoc's site.","fork":false,"url":"https://api.github.com/repos/SassDoc/sassdoc.github.io","forks_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/forks","keys_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/keys{/key_id}","collaborators_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/teams","hooks_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/hooks","issue_events_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/issues/events{/number}","events_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/events","assignees_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/assignees{/user}","branches_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/branches{/branch}","tags_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/tags","blobs_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/git/refs{/sha}","trees_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/git/trees{/sha}","statuses_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/statuses/{sha}","languages_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/languages","stargazers_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/stargazers","contributors_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/contributors","subscribers_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/subscribers","subscription_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/subscription","commits_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/commits{/sha}","git_commits_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/git/commits{/sha}","comments_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/comments{/number}","issue_comment_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/issues/comments/{number}","contents_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/contents/{+path}","compare_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/compare/{base}...{head}","merges_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/merges","archive_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/downloads","issues_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/issues{/number}","pulls_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/pulls{/number}","milestones_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/milestones{/number}","notifications_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/labels{/name}","releases_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/releases{/id}","created_at":"2014-08-02T12:05:36Z","updated_at":"2015-01-13T17:22:43Z","pushed_at":"2015-01-14T22:13:14Z","git_url":"git://github.com/SassDoc/sassdoc.github.io.git","ssh_url":"git@github.com:SassDoc/sassdoc.github.io.git","clone_url":"https://github.com/SassDoc/sassdoc.github.io.git","svn_url":"https://github.com/SassDoc/sassdoc.github.io","homepage":"http://sassdoc.com/","size":6355,"stargazers_count":0,"watchers_count":0,"language":"CSS","has_issues":true,"has_downloads":true,"has_wiki":false,"has_pages":true,"forks_count":3,"mirror_url":null,"open_issues_count":20,"forks":3,"open_issues":20,"watchers":0,"default_branch":"master"}},"base":{"label":"SassDoc:develop","ref":"develop","sha":"6c8fdf5a78679c3bad2100464eb9235671bdbd96","user":{"login":"SassDoc","id":8111770,"avatar_url":"https://avatars.githubusercontent.com/u/8111770?v=3","gravatar_id":"","url":"https://api.github.com/users/SassDoc","html_url":"https://github.com/SassDoc","followers_url":"https://api.github.com/users/SassDoc/followers","following_url":"https://api.github.com/users/SassDoc/following{/other_user}","gists_url":"https://api.github.com/users/SassDoc/gists{/gist_id}","starred_url":"https://api.github.com/users/SassDoc/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/SassDoc/subscriptions","organizations_url":"https://api.github.com/users/SassDoc/orgs","repos_url":"https://api.github.com/users/SassDoc/repos","events_url":"https://api.github.com/users/SassDoc/events{/privacy}","received_events_url":"https://api.github.com/users/SassDoc/received_events","type":"Organization","site_admin":false},"repo":{"id":22545386,"name":"sassdoc.github.io","full_name":"SassDoc/sassdoc.github.io","owner":{"login":"SassDoc","id":8111770,"avatar_url":"https://avatars.githubusercontent.com/u/8111770?v=3","gravatar_id":"","url":"https://api.github.com/users/SassDoc","html_url":"https://github.com/SassDoc","followers_url":"https://api.github.com/users/SassDoc/followers","following_url":"https://api.github.com/users/SassDoc/following{/other_user}","gists_url":"https://api.github.com/users/SassDoc/gists{/gist_id}","starred_url":"https://api.github.com/users/SassDoc/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/SassDoc/subscriptions","organizations_url":"https://api.github.com/users/SassDoc/orgs","repos_url":"https://api.github.com/users/SassDoc/repos","events_url":"https://api.github.com/users/SassDoc/events{/privacy}","received_events_url":"https://api.github.com/users/SassDoc/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/SassDoc/sassdoc.github.io","description":"SassDoc's site.","fork":false,"url":"https://api.github.com/repos/SassDoc/sassdoc.github.io","forks_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/forks","keys_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/keys{/key_id}","collaborators_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/teams","hooks_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/hooks","issue_events_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/issues/events{/number}","events_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/events","assignees_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/assignees{/user}","branches_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/branches{/branch}","tags_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/tags","blobs_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/git/refs{/sha}","trees_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/git/trees{/sha}","statuses_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/statuses/{sha}","languages_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/languages","stargazers_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/stargazers","contributors_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/contributors","subscribers_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/subscribers","subscription_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/subscription","commits_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/commits{/sha}","git_commits_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/git/commits{/sha}","comments_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/comments{/number}","issue_comment_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/issues/comments/{number}","contents_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/contents/{+path}","compare_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/compare/{base}...{head}","merges_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/merges","archive_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/downloads","issues_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/issues{/number}","pulls_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/pulls{/number}","milestones_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/milestones{/number}","notifications_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/labels{/name}","releases_url":"https://api.github.com/repos/SassDoc/sassdoc.github.io/releases{/id}","created_at":"2014-08-02T12:05:36Z","updated_at":"2015-01-13T17:22:43Z","pushed_at":"2015-01-14T22:13:14Z","git_url":"git://github.com/SassDoc/sassdoc.github.io.git","ssh_url":"git@github.com:SassDoc/sassdoc.github.io.git","clone_url":"https://github.com/SassDoc/sassdoc.github.io.git","svn_url":"https://github.com/SassDoc/sassdoc.github.io","homepage":"http://sassdoc.com/","size":6355,"stargazers_count":0,"watchers_count":0,"language":"CSS","has_issues":true,"has_downloads":true,"has_wiki":false,"has_pages":true,"forks_count":3,"mirror_url":null,"open_issues_count":20,"forks":3,"open_issues":20,"watchers":0,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/SassDoc/sassdoc.github.io/pulls/87"},"html":{"href":"https://github.com/SassDoc/sassdoc.github.io/pull/87"},"issue":{"href":"https://api.github.com/repos/SassDoc/sassdoc.github.io/issues/87"},"comments":{"href":"https://api.github.com/repos/SassDoc/sassdoc.github.io/issues/87/comments"},"review_comments":{"href":"https://api.github.com/repos/SassDoc/sassdoc.github.io/pulls/87/comments"},"review_comment":{"href":"https://api.github.com/repos/SassDoc/sassdoc.github.io/pulls/comments/{number}"},"commits":{"href":"https://api.github.com/repos/SassDoc/sassdoc.github.io/pulls/87/commits"},"statuses":{"href":"https://api.github.com/repos/SassDoc/sassdoc.github.io/statuses/822731b387187f21e4b1868d122ff3b1597d3c1c"}}}}