-
Notifications
You must be signed in to change notification settings - Fork 223
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes to add nav files to documentation #246
Conversation
nav.yml nav.html
For reference: http://planetjekyll.github.io/snippets/nav-with-data |
docs/_data/nav.yml
Outdated
subhref: "/soda-sql/documentation/glossary" | ||
|
||
- title: "Community" | ||
href: "/soda-sql/community" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You might want to change your editor to add empty new lines at the end of the file :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@janet-can I went ahead and resolved some of your "todo" items as per requested in the email. Some changes I made in sodadata/soda-sql@95460d9:
- Use references to pages (
page
) instead of hard-coded links in yournav.yml
. This should prevent any dead links, as well as prevent us from having to go through each link when making a structural change. (We can still support 'absolute links' as well, if you would like). - Adjusted the rendered template to re-use the template's classes. This gives the look and feel you're looking for.
- Widen up the nav bar a little to make sure all items stay on a single line.
- Toggle the sub-nav when one of its children is active (or when clicking on the array icon)
Closes sodadata/soda-sql#205 |
@janet-can I guess this PR on this repo is not needed anymore right ? Since we moved docs to https://github.com/sodadata/docs ? |
Rather than try to manage the navigation side-bar using numbers in the headers of docs files, I want to shift to using a nav.yml file in conjunction with a nav.html file. This PR gets us most of the way there, but there are still a couple of adjustments needed.
Any comments or feedback welcome! This will be a WAAAY better experience for organizing docs content.