better whitespace in docs
MareoRaft opened this issue · 10 comments
It's weird in the docs how the "example" section has an abnormally large amount of whitespace above it, and the title for a new function has almost no whitespace above it.
It makes it look like the "example" belongs to the function below it, when this is not the case.
Current doc image:
As you can see "(static) complement..." has almost no whitespace above it, but it should have a large amount of whitespace.
I want to play around with the CSS file a bit and make the docs more readable.
That would be great. I just use jsDoc out of the box and did not take the time for configuration yet.
There are even themes and plugins out there. Just check the http://usejsdoc.org/ pages.,
A few I liked...
docdash:
https://cancerberosgx.github.io/jsdoc-templates-demo/demo/docdash/Environment.html
braintree:
https://cancerberosgx.github.io/jsdoc-templates-demo/demo/braintree-jsdoc-template/Environment.html
pixi:
https://cancerberosgx.github.io/jsdoc-templates-demo/demo/pixi-jsdoc-template/Environment.html
docstrap:
https://github.com/docstrap/docstrap
See https://github.com/cancerberoSgx/jsdoc-templates-demo/blob/master/generate.sh for help in installing them...
I'm going to try out braintree and then modify the CSS to change the colors and spacing a bit. I also like docdash...
branches:
matt/master/braintree
matt/master/docdash
So basically what I can say is that I think braintree is prettier, but docdash is actually better for people trying to find the information they need.
Braintree puts the Wikipedia link in a more hidden spot. Docdash puts it up front. Docdash also puts the method names in big color swatches which makes it easier visually to see when a new method begins, which basically fixes the issue I was complaining about. Docdash also puts the Example block closer to the beginning, which i think is good because most people just want to see an example.
So I'm leaning towards docdash right now.
Hi, sorry for not responding. Had some crunch time on a project recently plus holidays etc. I also agree for docdash as it has a clear layout and I like the example boxes a lot.
@MareoRaft is it possible to merge this already into the current master?
No worries. So I customized docdash a bit to make it closer to the actual lodash stuff. I hope you like it. Let me know. Opening a PR to merge this into master.
merged in #35