Skip to content
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

added section headers to doc pages for easier nav #116

Merged
merged 1 commit into from Sep 24, 2018

Conversation

@Tavistock
Copy link
Contributor

Tavistock commented Sep 16, 2018

closes #20

Not really sure if it's what you had in mind but I took a swing at it anyways.

Some open topics are what level of header it should display (like should h4's and above not get added) and whether the top margin on body should be reduced.

It's the bar with the current section for anyone that doesn't want to build it:
screen shot 2018-09-16 at 7 38 03 pm

@martinklepsch

This comment has been minimized.

Copy link
Member

martinklepsch commented Sep 19, 2018

Oh wow, this is looking great from just glancing over the screenshot! I’m currently on vacation so it’ll take me until October to get to this but maybe other contributors will review & merge this in the meantime.

@saskali

This comment has been minimized.

Copy link
Contributor

saskali commented Sep 24, 2018

changes look good to me! super nice to have this as an additional UI element. thanks for your contribution Travis 😃 🙌 I'll go ahead and merge

@saskali saskali merged commit 38d6655 into cljdoc:master Sep 24, 2018
@martinklepsch

This comment has been minimized.

Copy link
Member

martinklepsch commented Oct 1, 2018

Just deployed this, thanks again for the contribution Travis! A live demo can be seen in the muuntaja docs 🙂

martinklepsch added a commit that referenced this pull request Nov 14, 2018
This change was intended to make it easier to navigate longer documents
but so far we didn't get to implement a proper Table Of Contents view
on top of the work that has already been done in PR #116.

With the upcoming responsiveness improvements the layout constraints
changed and keeping this around would have been significant work.

I'm also slowly getting my head around having a Table of Contents as
a secondary sidebar similar to how Docosaurus and other tools handle
this — Something the existing approach isn't really compatible with.
martinklepsch added a commit that referenced this pull request Nov 15, 2018
This change was intended to make it easier to navigate longer documents
but so far we didn't get to implement a proper Table Of Contents view
on top of the work that has already been done in PR #116.

With the upcoming responsiveness improvements the layout constraints
changed and keeping this around would have been significant work.

I'm also slowly getting my head around having a Table of Contents as
a secondary sidebar similar to how Docosaurus and other tools handle
this — Something the existing approach isn't really compatible with.
martinklepsch added a commit that referenced this pull request Nov 16, 2018
This change was intended to make it easier to navigate longer documents
but so far we didn't get to implement a proper Table Of Contents view
on top of the work that has already been done in PR #116.

With the upcoming responsiveness improvements the layout constraints
changed and keeping this around would have been significant work.

I'm also slowly getting my head around having a Table of Contents as
a secondary sidebar similar to how Docosaurus and other tools handle
this — Something the existing approach isn't really compatible with.
martinklepsch added a commit that referenced this pull request Nov 16, 2018
This change was intended to make it easier to navigate longer documents
but so far we didn't get to implement a proper Table Of Contents view
on top of the work that has already been done in PR #116.

With the upcoming responsiveness improvements the layout constraints
changed and keeping this around would have been significant work.

I'm also slowly getting my head around having a Table of Contents as
a secondary sidebar similar to how Docosaurus and other tools handle
this — Something the existing approach isn't really compatible with.
martinklepsch added a commit that referenced this pull request Nov 16, 2018
This change was intended to make it easier to navigate longer documents
but so far we didn't get to implement a proper Table Of Contents view
on top of the work that has already been done in PR #116.

With the upcoming responsiveness improvements the layout constraints
changed and keeping this around would have been significant work.

I'm also slowly getting my head around having a Table of Contents as
a secondary sidebar similar to how Docosaurus and other tools handle
this — Something the existing approach isn't really compatible with.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.