{"action":"created","comment":{"url":"https://api.github.com/repos/dotnet/docfx/pulls/comments/57114217","id":57114217,"diff_hunk":"@@ -0,0 +1,99 @@\n+Table-Of-Content(TOC) Files\n+===========================\n+\n+Introduction\n+---------------------\n+DocFX is able to process YAML files, which we call *Metadata File*s, and Markdown files, which we call *Conceptual File*s. Besides that, DocFX introduces a way to organize these files using *Table-Of-Content File*s, which we also call *TOC File*s, so that users can navigate through *Metadata File*s and *Conceptual File*s.\n+\n+*TOC File*s must have file name `toc.md` or `toc.yml`, notice that file name is case-insensitive.\n+\n+Basic format\n+----------------\n+### Markdown format TOC `toc.md`\n+\n+`toc.md` leverage Markdown [Atx-style headers](http://daringfireball.net/projects/markdown/syntax#header) which use 1-6 hash characters at the start of the line to represent the TOC levels 1-6. We call each line starting with hash characters a *TOC Item*. A *TOC Item* with higher level is considered as the child of the nearest upper *TOC Item* with less level. A sample `toc.md` is as below:","path":"Documentation/tutorial/intro_toc.md","position":14,"original_position":14,"commit_id":"6deadb69ef48b3fcd745504024e6f330f124d447","original_commit_id":"6deadb69ef48b3fcd745504024e6f330f124d447","user":{"login":"chenkennt","id":8436953,"avatar_url":"https://avatars.githubusercontent.com/u/8436953?v=3","gravatar_id":"","url":"https://api.github.com/users/chenkennt","html_url":"https://github.com/chenkennt","followers_url":"https://api.github.com/users/chenkennt/followers","following_url":"https://api.github.com/users/chenkennt/following{/other_user}","gists_url":"https://api.github.com/users/chenkennt/gists{/gist_id}","starred_url":"https://api.github.com/users/chenkennt/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/chenkennt/subscriptions","organizations_url":"https://api.github.com/users/chenkennt/orgs","repos_url":"https://api.github.com/users/chenkennt/repos","events_url":"https://api.github.com/users/chenkennt/events{/privacy}","received_events_url":"https://api.github.com/users/chenkennt/received_events","type":"User","site_admin":false},"body":"inner vs. outer?\r\n\r\n---\r\nIn reply to: [57005600](https://github.com/dotnet/docfx/pull/232#discussion_r57005600) [](ancestors = 57005600)","created_at":"2016-03-23T06:13:37Z","updated_at":"2016-03-23T06:13:37Z","html_url":"https://github.com/dotnet/docfx/pull/232#discussion_r57114217","pull_request_url":"https://api.github.com/repos/dotnet/docfx/pulls/232","_links":{"self":{"href":"https://api.github.com/repos/dotnet/docfx/pulls/comments/57114217"},"html":{"href":"https://github.com/dotnet/docfx/pull/232#discussion_r57114217"},"pull_request":{"href":"https://api.github.com/repos/dotnet/docfx/pulls/232"}}},"pull_request":{"url":"https://api.github.com/repos/dotnet/docfx/pulls/232","id":63683398,"html_url":"https://github.com/dotnet/docfx/pull/232","diff_url":"https://github.com/dotnet/docfx/pull/232.diff","patch_url":"https://github.com/dotnet/docfx/pull/232.patch","issue_url":"https://api.github.com/repos/dotnet/docfx/issues/232","number":232,"state":"open","locked":false,"title":"Add documentation for TOC files","user":{"login":"vicancy","id":668244,"avatar_url":"https://avatars.githubusercontent.com/u/668244?v=3","gravatar_id":"","url":"https://api.github.com/users/vicancy","html_url":"https://github.com/vicancy","followers_url":"https://api.github.com/users/vicancy/followers","following_url":"https://api.github.com/users/vicancy/following{/other_user}","gists_url":"https://api.github.com/users/vicancy/gists{/gist_id}","starred_url":"https://api.github.com/users/vicancy/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/vicancy/subscriptions","organizations_url":"https://api.github.com/users/vicancy/orgs","repos_url":"https://api.github.com/users/vicancy/repos","events_url":"https://api.github.com/users/vicancy/events{/privacy}","received_events_url":"https://api.github.com/users/vicancy/received_events","type":"User","site_admin":false},"body":"@vwxyzh @superyyrrzz @chenkennt @qinezh ","created_at":"2016-03-22T08:18:17Z","updated_at":"2016-03-23T06:13:37Z","closed_at":null,"merged_at":null,"merge_commit_sha":"eab8c62fdea3496a2b978018e14af157873fc855","assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/dotnet/docfx/pulls/232/commits","review_comments_url":"https://api.github.com/repos/dotnet/docfx/pulls/232/comments","review_comment_url":"https://api.github.com/repos/dotnet/docfx/pulls/comments{/number}","comments_url":"https://api.github.com/repos/dotnet/docfx/issues/232/comments","statuses_url":"https://api.github.com/repos/dotnet/docfx/statuses/6deadb69ef48b3fcd745504024e6f330f124d447","head":{"label":"vicancy:toc_doc","ref":"toc_doc","sha":"6deadb69ef48b3fcd745504024e6f330f124d447","user":{"login":"vicancy","id":668244,"avatar_url":"https://avatars.githubusercontent.com/u/668244?v=3","gravatar_id":"","url":"https://api.github.com/users/vicancy","html_url":"https://github.com/vicancy","followers_url":"https://api.github.com/users/vicancy/followers","following_url":"https://api.github.com/users/vicancy/following{/other_user}","gists_url":"https://api.github.com/users/vicancy/gists{/gist_id}","starred_url":"https://api.github.com/users/vicancy/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/vicancy/subscriptions","organizations_url":"https://api.github.com/users/vicancy/orgs","repos_url":"https://api.github.com/users/vicancy/repos","events_url":"https://api.github.com/users/vicancy/events{/privacy}","received_events_url":"https://api.github.com/users/vicancy/received_events","type":"User","site_admin":false},"repo":{"id":49409630,"name":"docfx","full_name":"vicancy/docfx","owner":{"login":"vicancy","id":668244,"avatar_url":"https://avatars.githubusercontent.com/u/668244?v=3","gravatar_id":"","url":"https://api.github.com/users/vicancy","html_url":"https://github.com/vicancy","followers_url":"https://api.github.com/users/vicancy/followers","following_url":"https://api.github.com/users/vicancy/following{/other_user}","gists_url":"https://api.github.com/users/vicancy/gists{/gist_id}","starred_url":"https://api.github.com/users/vicancy/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/vicancy/subscriptions","organizations_url":"https://api.github.com/users/vicancy/orgs","repos_url":"https://api.github.com/users/vicancy/repos","events_url":"https://api.github.com/users/vicancy/events{/privacy}","received_events_url":"https://api.github.com/users/vicancy/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/vicancy/docfx","description":"Tools for building and publishing API documentation for .NET projects","fork":true,"url":"https://api.github.com/repos/vicancy/docfx","forks_url":"https://api.github.com/repos/vicancy/docfx/forks","keys_url":"https://api.github.com/repos/vicancy/docfx/keys{/key_id}","collaborators_url":"https://api.github.com/repos/vicancy/docfx/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/vicancy/docfx/teams","hooks_url":"https://api.github.com/repos/vicancy/docfx/hooks","issue_events_url":"https://api.github.com/repos/vicancy/docfx/issues/events{/number}","events_url":"https://api.github.com/repos/vicancy/docfx/events","assignees_url":"https://api.github.com/repos/vicancy/docfx/assignees{/user}","branches_url":"https://api.github.com/repos/vicancy/docfx/branches{/branch}","tags_url":"https://api.github.com/repos/vicancy/docfx/tags","blobs_url":"https://api.github.com/repos/vicancy/docfx/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/vicancy/docfx/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/vicancy/docfx/git/refs{/sha}","trees_url":"https://api.github.com/repos/vicancy/docfx/git/trees{/sha}","statuses_url":"https://api.github.com/repos/vicancy/docfx/statuses/{sha}","languages_url":"https://api.github.com/repos/vicancy/docfx/languages","stargazers_url":"https://api.github.com/repos/vicancy/docfx/stargazers","contributors_url":"https://api.github.com/repos/vicancy/docfx/contributors","subscribers_url":"https://api.github.com/repos/vicancy/docfx/subscribers","subscription_url":"https://api.github.com/repos/vicancy/docfx/subscription","commits_url":"https://api.github.com/repos/vicancy/docfx/commits{/sha}","git_commits_url":"https://api.github.com/repos/vicancy/docfx/git/commits{/sha}","comments_url":"https://api.github.com/repos/vicancy/docfx/comments{/number}","issue_comment_url":"https://api.github.com/repos/vicancy/docfx/issues/comments{/number}","contents_url":"https://api.github.com/repos/vicancy/docfx/contents/{+path}","compare_url":"https://api.github.com/repos/vicancy/docfx/compare/{base}...{head}","merges_url":"https://api.github.com/repos/vicancy/docfx/merges","archive_url":"https://api.github.com/repos/vicancy/docfx/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/vicancy/docfx/downloads","issues_url":"https://api.github.com/repos/vicancy/docfx/issues{/number}","pulls_url":"https://api.github.com/repos/vicancy/docfx/pulls{/number}","milestones_url":"https://api.github.com/repos/vicancy/docfx/milestones{/number}","notifications_url":"https://api.github.com/repos/vicancy/docfx/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/vicancy/docfx/labels{/name}","releases_url":"https://api.github.com/repos/vicancy/docfx/releases{/id}","deployments_url":"https://api.github.com/repos/vicancy/docfx/deployments","created_at":"2016-01-11T07:31:48Z","updated_at":"2016-01-19T05:05:40Z","pushed_at":"2016-03-22T15:57:48Z","git_url":"git://github.com/vicancy/docfx.git","ssh_url":"git@github.com:vicancy/docfx.git","clone_url":"https://github.com/vicancy/docfx.git","svn_url":"https://github.com/vicancy/docfx","homepage":"http://dotnet.github.io/docfx/","size":65258,"stargazers_count":0,"watchers_count":0,"language":"C#","has_issues":false,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":1,"mirror_url":null,"open_issues_count":0,"forks":1,"open_issues":0,"watchers":0,"default_branch":"dev"}},"base":{"label":"dotnet:dev","ref":"dev","sha":"8a250048f433dd176fb9e5b1eccef994b11121f0","user":{"login":"dotnet","id":9141961,"avatar_url":"https://avatars.githubusercontent.com/u/9141961?v=3","gravatar_id":"","url":"https://api.github.com/users/dotnet","html_url":"https://github.com/dotnet","followers_url":"https://api.github.com/users/dotnet/followers","following_url":"https://api.github.com/users/dotnet/following{/other_user}","gists_url":"https://api.github.com/users/dotnet/gists{/gist_id}","starred_url":"https://api.github.com/users/dotnet/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dotnet/subscriptions","organizations_url":"https://api.github.com/users/dotnet/orgs","repos_url":"https://api.github.com/users/dotnet/repos","events_url":"https://api.github.com/users/dotnet/events{/privacy}","received_events_url":"https://api.github.com/users/dotnet/received_events","type":"Organization","site_admin":false},"repo":{"id":38007053,"name":"docfx","full_name":"dotnet/docfx","owner":{"login":"dotnet","id":9141961,"avatar_url":"https://avatars.githubusercontent.com/u/9141961?v=3","gravatar_id":"","url":"https://api.github.com/users/dotnet","html_url":"https://github.com/dotnet","followers_url":"https://api.github.com/users/dotnet/followers","following_url":"https://api.github.com/users/dotnet/following{/other_user}","gists_url":"https://api.github.com/users/dotnet/gists{/gist_id}","starred_url":"https://api.github.com/users/dotnet/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dotnet/subscriptions","organizations_url":"https://api.github.com/users/dotnet/orgs","repos_url":"https://api.github.com/users/dotnet/repos","events_url":"https://api.github.com/users/dotnet/events{/privacy}","received_events_url":"https://api.github.com/users/dotnet/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/dotnet/docfx","description":"Tools for building and publishing API documentation for .NET projects","fork":false,"url":"https://api.github.com/repos/dotnet/docfx","forks_url":"https://api.github.com/repos/dotnet/docfx/forks","keys_url":"https://api.github.com/repos/dotnet/docfx/keys{/key_id}","collaborators_url":"https://api.github.com/repos/dotnet/docfx/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/dotnet/docfx/teams","hooks_url":"https://api.github.com/repos/dotnet/docfx/hooks","issue_events_url":"https://api.github.com/repos/dotnet/docfx/issues/events{/number}","events_url":"https://api.github.com/repos/dotnet/docfx/events","assignees_url":"https://api.github.com/repos/dotnet/docfx/assignees{/user}","branches_url":"https://api.github.com/repos/dotnet/docfx/branches{/branch}","tags_url":"https://api.github.com/repos/dotnet/docfx/tags","blobs_url":"https://api.github.com/repos/dotnet/docfx/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/dotnet/docfx/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/dotnet/docfx/git/refs{/sha}","trees_url":"https://api.github.com/repos/dotnet/docfx/git/trees{/sha}","statuses_url":"https://api.github.com/repos/dotnet/docfx/statuses/{sha}","languages_url":"https://api.github.com/repos/dotnet/docfx/languages","stargazers_url":"https://api.github.com/repos/dotnet/docfx/stargazers","contributors_url":"https://api.github.com/repos/dotnet/docfx/contributors","subscribers_url":"https://api.github.com/repos/dotnet/docfx/subscribers","subscription_url":"https://api.github.com/repos/dotnet/docfx/subscription","commits_url":"https://api.github.com/repos/dotnet/docfx/commits{/sha}","git_commits_url":"https://api.github.com/repos/dotnet/docfx/git/commits{/sha}","comments_url":"https://api.github.com/repos/dotnet/docfx/comments{/number}","issue_comment_url":"https://api.github.com/repos/dotnet/docfx/issues/comments{/number}","contents_url":"https://api.github.com/repos/dotnet/docfx/contents/{+path}","compare_url":"https://api.github.com/repos/dotnet/docfx/compare/{base}...{head}","merges_url":"https://api.github.com/repos/dotnet/docfx/merges","archive_url":"https://api.github.com/repos/dotnet/docfx/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/dotnet/docfx/downloads","issues_url":"https://api.github.com/repos/dotnet/docfx/issues{/number}","pulls_url":"https://api.github.com/repos/dotnet/docfx/pulls{/number}","milestones_url":"https://api.github.com/repos/dotnet/docfx/milestones{/number}","notifications_url":"https://api.github.com/repos/dotnet/docfx/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/dotnet/docfx/labels{/name}","releases_url":"https://api.github.com/repos/dotnet/docfx/releases{/id}","deployments_url":"https://api.github.com/repos/dotnet/docfx/deployments","created_at":"2015-06-24T19:43:53Z","updated_at":"2016-03-22T15:30:06Z","pushed_at":"2016-03-23T05:40:04Z","git_url":"git://github.com/dotnet/docfx.git","ssh_url":"git@github.com:dotnet/docfx.git","clone_url":"https://github.com/dotnet/docfx.git","svn_url":"https://github.com/dotnet/docfx","homepage":"http://dotnet.github.io/docfx/","size":89623,"stargazers_count":296,"watchers_count":296,"language":"C#","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":true,"forks_count":74,"mirror_url":null,"open_issues_count":60,"forks":74,"open_issues":60,"watchers":296,"default_branch":"dev"}},"_links":{"self":{"href":"https://api.github.com/repos/dotnet/docfx/pulls/232"},"html":{"href":"https://github.com/dotnet/docfx/pull/232"},"issue":{"href":"https://api.github.com/repos/dotnet/docfx/issues/232"},"comments":{"href":"https://api.github.com/repos/dotnet/docfx/issues/232/comments"},"review_comments":{"href":"https://api.github.com/repos/dotnet/docfx/pulls/232/comments"},"review_comment":{"href":"https://api.github.com/repos/dotnet/docfx/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/dotnet/docfx/pulls/232/commits"},"statuses":{"href":"https://api.github.com/repos/dotnet/docfx/statuses/6deadb69ef48b3fcd745504024e6f330f124d447"}}}}