{"action":"created","issue":{"url":"https://api.github.com/repos/rust-lang/cargo/issues/2694","repository_url":"https://api.github.com/repos/rust-lang/cargo","labels_url":"https://api.github.com/repos/rust-lang/cargo/issues/2694/labels{/name}","comments_url":"https://api.github.com/repos/rust-lang/cargo/issues/2694/comments","events_url":"https://api.github.com/repos/rust-lang/cargo/issues/2694/events","html_url":"https://github.com/rust-lang/cargo/issues/2694","id":154920046,"node_id":"MDU6SXNzdWUxNTQ5MjAwNDY=","number":2694,"title":"Generate table of contents for docs at http://doc.crates.io","user":{"login":"smaximov","id":1370047,"node_id":"MDQ6VXNlcjEzNzAwNDc=","avatar_url":"https://avatars3.githubusercontent.com/u/1370047?v=4","gravatar_id":"","url":"https://api.github.com/users/smaximov","html_url":"https://github.com/smaximov","followers_url":"https://api.github.com/users/smaximov/followers","following_url":"https://api.github.com/users/smaximov/following{/other_user}","gists_url":"https://api.github.com/users/smaximov/gists{/gist_id}","starred_url":"https://api.github.com/users/smaximov/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/smaximov/subscriptions","organizations_url":"https://api.github.com/users/smaximov/orgs","repos_url":"https://api.github.com/users/smaximov/repos","events_url":"https://api.github.com/users/smaximov/events{/privacy}","received_events_url":"https://api.github.com/users/smaximov/received_events","type":"User","site_admin":false},"labels":[{"id":137469209,"node_id":"MDU6TGFiZWwxMzc0NjkyMDk=","url":"https://api.github.com/repos/rust-lang/cargo/labels/A-documenting-cargo-itself","name":"A-documenting-cargo-itself","color":"fbca04","default":false}],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":8,"created_at":"2016-05-15T17:35:24Z","updated_at":"2018-07-23T16:31:08Z","closed_at":null,"author_association":"CONTRIBUTOR","body":"It would be nice to have TOCs for documentation articles. TOC gives a summary of topics an article addresses and allows to quickly navigate between sections.\n### How it can be implemented\n- Place some marker (e.g. `%TOC%`) in a Mardown file:\n  \n  ``` markdown\n  % Cargo Guide\n  \n  Welcome to the Cargo guide. This guide will give you all that you need to know\n  about how to use Cargo to develop Rust projects.\n  \n  %TOC%\n  \n  # Why Cargo exists\n  ...\n  ```\n- Use some tool ([first hit in google](https://github.com/ekalinin/github-markdown-toc), actually works) to generate TOC.\n- Replace the marker with the generated TOC.\n### Mockups\n\nSimple TOC:\n\n![toc](https://cloud.githubusercontent.com/assets/1370047/15275596/6572eaea-1b13-11e6-8b20-6ca9ae3a6979.png)\n\nFixed (\"sticky\") sidebar TOC:\n![toc-fixed](https://cloud.githubusercontent.com/assets/1370047/15275597/6573472e-1b13-11e6-9e97-85f3f9833db5.png)\n"},"comment":{"url":"https://api.github.com/repos/rust-lang/cargo/issues/comments/407119636","html_url":"https://github.com/rust-lang/cargo/issues/2694#issuecomment-407119636","issue_url":"https://api.github.com/repos/rust-lang/cargo/issues/2694","id":407119636,"node_id":"MDEyOklzc3VlQ29tbWVudDQwNzExOTYzNg==","user":{"login":"dwijnand","id":344610,"node_id":"MDQ6VXNlcjM0NDYxMA==","avatar_url":"https://avatars1.githubusercontent.com/u/344610?v=4","gravatar_id":"","url":"https://api.github.com/users/dwijnand","html_url":"https://github.com/dwijnand","followers_url":"https://api.github.com/users/dwijnand/followers","following_url":"https://api.github.com/users/dwijnand/following{/other_user}","gists_url":"https://api.github.com/users/dwijnand/gists{/gist_id}","starred_url":"https://api.github.com/users/dwijnand/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dwijnand/subscriptions","organizations_url":"https://api.github.com/users/dwijnand/orgs","repos_url":"https://api.github.com/users/dwijnand/repos","events_url":"https://api.github.com/users/dwijnand/events{/privacy}","received_events_url":"https://api.github.com/users/dwijnand/received_events","type":"User","site_admin":false},"created_at":"2018-07-23T16:31:08Z","updated_at":"2018-07-23T16:31:08Z","author_association":"CONTRIBUTOR","body":"This think this can be closed now. The cargo docs now use mdbook, and thus have a sidebar TOC."}}
{"actor":{"display_login":"dwijnand"}}