search

handlebars-lang / docs

Documentation for handlebars.js and the handlebars-language
https://handlebarsjs.com
MIT License
36 stars 47 forks source link

move github link to bottom #112

Closed ghost closed 2 years ago

ghost commented 2 years ago

Hey, I thought it would make sense to move the GitHub link to the bottom to save space in the top nav bar. This is a continuation of PR #105.

ilharp commented 2 years ago

IMO, space usage in top nav isn't such a big problem... And by some kind of convention, the vast majority of OSS doc site always has the GitHub link in the nav right corner, such as mkdocs, Docusaurus and of cource VuePress. This encourages people to have a look at its source code and star the project.

ghost commented 2 years ago

@ilharp I see the argument for having it in the upper right. I'm on a 12" laptop though, and I don't like that the links cut off at the top if the browser window is too small. Someone could easily miss the link that way.

The nav is longer than most out there thus the pages need an all-around better responsive/mobile view; when there isn't room for all the links, a media query should force a mobile menu giving the user access to everything. Good responsive design is a broader convention than having the Github link at the top right. Also, if someone wants to contribute they will specifically look for the link anyway.

I initially wanted to move it to the footer but it's written in YAML and won't take HTML. I think it'd be ideal to move the Languages option to the index page as well, but it's a bit complex with the way VuePress is set up (at least for me, I'm not too familiar with it).

It may boil down to personal preference to a degree but I think this was a helpful PR :)

ghost commented 2 years ago

@nknapp and @papasmile : Just wondering if this will be merged or closed? Lmk so I can delete my branch :)

papasmile commented 2 years ago

Hiya, @christinavoudouris , et al. My vote would be for a better responsive break point that would cleanly keep links on top for larger screens and switch to collapsed nav for smaller screens.