{"action":"created","issue":{"url":"https://api.github.com/repos/MarkBind/markbind/issues/465","repository_url":"https://api.github.com/repos/MarkBind/markbind","labels_url":"https://api.github.com/repos/MarkBind/markbind/issues/465/labels{/name}","comments_url":"https://api.github.com/repos/MarkBind/markbind/issues/465/comments","events_url":"https://api.github.com/repos/MarkBind/markbind/issues/465/events","html_url":"https://github.com/MarkBind/markbind/pull/465","id":390101193,"node_id":"MDExOlB1bGxSZXF1ZXN0MjM3OTM5ODgz","number":465,"title":"[WIP] Support Page Navigation Sidebar","user":{"login":"Chng-Zhi-Xuan","id":31084833,"node_id":"MDQ6VXNlcjMxMDg0ODMz","avatar_url":"https://avatars3.githubusercontent.com/u/31084833?v=4","gravatar_id":"","url":"https://api.github.com/users/Chng-Zhi-Xuan","html_url":"https://github.com/Chng-Zhi-Xuan","followers_url":"https://api.github.com/users/Chng-Zhi-Xuan/followers","following_url":"https://api.github.com/users/Chng-Zhi-Xuan/following{/other_user}","gists_url":"https://api.github.com/users/Chng-Zhi-Xuan/gists{/gist_id}","starred_url":"https://api.github.com/users/Chng-Zhi-Xuan/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Chng-Zhi-Xuan/subscriptions","organizations_url":"https://api.github.com/users/Chng-Zhi-Xuan/orgs","repos_url":"https://api.github.com/users/Chng-Zhi-Xuan/repos","events_url":"https://api.github.com/users/Chng-Zhi-Xuan/events{/privacy}","received_events_url":"https://api.github.com/users/Chng-Zhi-Xuan/received_events","type":"User","site_admin":false},"labels":[{"id":939362626,"node_id":"MDU6TGFiZWw5MzkzNjI2MjY=","url":"https://api.github.com/repos/MarkBind/markbind/labels/s.UnderDiscussion","name":"s.UnderDiscussion","color":"f2dc9f","default":false}],"state":"open","locked":false,"assignee":{"login":"Chng-Zhi-Xuan","id":31084833,"node_id":"MDQ6VXNlcjMxMDg0ODMz","avatar_url":"https://avatars3.githubusercontent.com/u/31084833?v=4","gravatar_id":"","url":"https://api.github.com/users/Chng-Zhi-Xuan","html_url":"https://github.com/Chng-Zhi-Xuan","followers_url":"https://api.github.com/users/Chng-Zhi-Xuan/followers","following_url":"https://api.github.com/users/Chng-Zhi-Xuan/following{/other_user}","gists_url":"https://api.github.com/users/Chng-Zhi-Xuan/gists{/gist_id}","starred_url":"https://api.github.com/users/Chng-Zhi-Xuan/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Chng-Zhi-Xuan/subscriptions","organizations_url":"https://api.github.com/users/Chng-Zhi-Xuan/orgs","repos_url":"https://api.github.com/users/Chng-Zhi-Xuan/repos","events_url":"https://api.github.com/users/Chng-Zhi-Xuan/events{/privacy}","received_events_url":"https://api.github.com/users/Chng-Zhi-Xuan/received_events","type":"User","site_admin":false},"assignees":[{"login":"Chng-Zhi-Xuan","id":31084833,"node_id":"MDQ6VXNlcjMxMDg0ODMz","avatar_url":"https://avatars3.githubusercontent.com/u/31084833?v=4","gravatar_id":"","url":"https://api.github.com/users/Chng-Zhi-Xuan","html_url":"https://github.com/Chng-Zhi-Xuan","followers_url":"https://api.github.com/users/Chng-Zhi-Xuan/followers","following_url":"https://api.github.com/users/Chng-Zhi-Xuan/following{/other_user}","gists_url":"https://api.github.com/users/Chng-Zhi-Xuan/gists{/gist_id}","starred_url":"https://api.github.com/users/Chng-Zhi-Xuan/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Chng-Zhi-Xuan/subscriptions","organizations_url":"https://api.github.com/users/Chng-Zhi-Xuan/orgs","repos_url":"https://api.github.com/users/Chng-Zhi-Xuan/repos","events_url":"https://api.github.com/users/Chng-Zhi-Xuan/events{/privacy}","received_events_url":"https://api.github.com/users/Chng-Zhi-Xuan/received_events","type":"User","site_admin":false}],"milestone":null,"comments":17,"created_at":"2018-12-12T07:42:03Z","updated_at":"2019-01-05T03:59:24Z","closed_at":null,"author_association":"CONTRIBUTOR","pull_request":{"url":"https://api.github.com/repos/MarkBind/markbind/pulls/465","html_url":"https://github.com/MarkBind/markbind/pull/465","diff_url":"https://github.com/MarkBind/markbind/pull/465.diff","patch_url":"https://github.com/MarkBind/markbind/pull/465.patch"},"body":"**What is the purpose of this pull request? (put \"X\" next to an item, remove the rest)**\r\n\r\n• [x] Documentation update\r\n• [x] New feature\r\n\r\n<!--\r\n    If this pull request is addressing an issue, link to the issue: \"Fixes #xxx\" or \"Resolves #xxx\"\r\n-->\r\nResolves #219 \r\n\r\n<!--\r\n    Please ensure your pull request is ready:\r\n    - Bug fix PR that is non-trivial **should** add a page or unit test for regression testing.\r\n    - Feature PR **must** add a page to the user guide for demo.\r\n    - Enhancement PR **should** update the user guide.\r\n\r\n    Otherwise, prefix your PR title with \"[WIP]\".\r\n-->\r\n\r\n**What is the rationale for this request?**\r\nUser would like to be able to use a page navigation component that is automatically generated from headings within the page.\r\n\r\nPrototype 2 Demo |\r\n--- |\r\n![page-nav-prototype-2](https://user-images.githubusercontent.com/31084833/49989973-f8e9c200-ffb6-11e8-9dc9-4c4c0d23eb11.gif) |\r\n\r\nPrototype 3, Responsive Design Demo |\r\n--- |\r\n![page-nav-responsive](https://user-images.githubusercontent.com/31084833/50473448-e67c7900-09f7-11e9-8734-527cbf5c08ff.gif)\r\n\r\n\r\n\r\nTo Do | Done?\r\n--- | ---\r\nResponsive design | ✔️  \r\nChange specifying `pageNav` within `front-matter` from `Boolean` to `{1 ... 6} or default` | ✔️ \r\nAdd specifying `pageNavHeader` to `front-matter` as the header text for page navigation | ✔️ \r\nAdaptive CSS if `site-nav` or `footer` is not specified in the page | ✔️  \r\nPage navigation automatically scrolls to active heading as user scroll the page | ✔️ \r\nIndentation of smaller headings | ✔️  \r\nInclude headings in `Panel headers` and `Panel contents` if expanded  | ✔️ \r\nLive preview via `markbind serve` re-inserts page navigation | ✔️ \r\nUpdate test site to use page navigation | ✔️ \r\nChange page navigation and scroll bar styling from default Bootstrap theme | ❌ \r\nUpdate documentation for new feature and using it | ❌ \r\nSupport auto expanding and collapsing of panels upon clicking an anchor link | ⚠️<br> On hold \r\n\r\n \r\nReferences |\r\n--- |\r\n[Bootstrap Scrollspy](https://getbootstrap.com/docs/4.0/components/scrollspy/) |\r\n[Scrollspy Event Handling](https://stackoverflow.com/questions/48693913/bootstrap-4-activate-bs-scrollspy-event-is-not-firing) |\r\n\r\n**Testing instructions:**\r\n1. Use Netlify Preview\r\n1. Go to the \"Docs\" tab then \"Using Components\" sub section and the page navigation bar should appear."},"comment":{"url":"https://api.github.com/repos/MarkBind/markbind/issues/comments/451625452","html_url":"https://github.com/MarkBind/markbind/pull/465#issuecomment-451625452","issue_url":"https://api.github.com/repos/MarkBind/markbind/issues/465","id":451625452,"node_id":"MDEyOklzc3VlQ29tbWVudDQ1MTYyNTQ1Mg==","user":{"login":"Chng-Zhi-Xuan","id":31084833,"node_id":"MDQ6VXNlcjMxMDg0ODMz","avatar_url":"https://avatars3.githubusercontent.com/u/31084833?v=4","gravatar_id":"","url":"https://api.github.com/users/Chng-Zhi-Xuan","html_url":"https://github.com/Chng-Zhi-Xuan","followers_url":"https://api.github.com/users/Chng-Zhi-Xuan/followers","following_url":"https://api.github.com/users/Chng-Zhi-Xuan/following{/other_user}","gists_url":"https://api.github.com/users/Chng-Zhi-Xuan/gists{/gist_id}","starred_url":"https://api.github.com/users/Chng-Zhi-Xuan/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Chng-Zhi-Xuan/subscriptions","organizations_url":"https://api.github.com/users/Chng-Zhi-Xuan/orgs","repos_url":"https://api.github.com/users/Chng-Zhi-Xuan/repos","events_url":"https://api.github.com/users/Chng-Zhi-Xuan/events{/privacy}","received_events_url":"https://api.github.com/users/Chng-Zhi-Xuan/received_events","type":"User","site_admin":false},"created_at":"2019-01-05T03:59:24Z","updated_at":"2019-01-05T03:59:24Z","author_association":"CONTRIBUTOR","body":"> Introduce a new file e.g., settings.md into layouts that can contain this kind of settings?\r\n\r\nTo extend your idea, currently the layout files for footer and other items are separated. It would be neater if all the different files (footer, siteNav, css) are all stored in their respective folders and have a simple `settings.md` file to \"store\" the file names required. Basically abstracting layouts to just a front matter file.\r\n\r\nE.G, content within `settings.md`:\r\n```\r\ncss: colorTheme1.css, blackTheme2.css\r\nfooter: simpleFooter.md\r\npageNav: default\r\npageNavHeader: \"This is a list of stuff\"\r\nsiteNav: mySiteNav.md\r\nscript: myScript1.js, myScript2.js\r\n```\r\n\r\nThen all the different file types are just stored in their respective folders within `_/markbind`"}}
{"actor":{"display_login":"Chng-Zhi-Xuan"}}