search

ctargett / refguide-asciidoc-poc

Proof of concept of Solr Ref Guide converted to asciidoc format & using Asciidoctor for publishing
2 stars 4 forks source link

nav building code can also create a data file for use by prev/up/next links in jekyll to template #35

Closed hossman closed 7 years ago

hossman commented 7 years ago

cwiki has the {scrollbar} macro which added the nice previous/up/next links to the footer of each page -- assuming we remembered to include the macro at the bottom of each page.

It occurs to me that the existing code we have to parse the adoc files for building _data/sidebar.json could also build a _data/footer_links.json file that we could use in our jekyll templates to generate prev/next/parent links (and unlike the cwiki macro: we could actaully make the prev/next links work even when there are no immediate siblings in that directly, but going to the next "parent" section)

ctargett commented 7 years ago

I was thinking about this today. I would love to have prev-next links that we could actually control.

I was also thinking about breadcrumbs, but with the current sidebar highlighting where it shows where you are in the tree maybe this is not that interesting.

hossman commented 7 years ago

I would love to have prev-next links that we could actually control.

I'll see if i can get some time to bang out a quick POC tomorrow before i go on vacation

I was also thinking about breadcrumbs, but with the current sidebar highlighting where it shows where you are in the tree maybe this is not that interesting.

agreed, but FWIW creating a _data file with breadcrumb info for every page would also be trivial to add to our nav building code.

hossman commented 7 years ago

i've updated master with this data file, and some quick work including it in the templates.

@ctargett - leaving open so you can re-theme/style as you see fit.

ctargett commented 7 years ago

I changed the links to buttons using bootstrap. I'm not sure about the color...it's in the style guide, but it's really orange, and I'm not sure I can handle more orange right now.

Leaving open to think about it.

ctargett commented 7 years ago

I updated the colors of the buttons to green & blue - that's OK for now. We will need to do some testing for color blindness, but there's no need holding things up for that.