Open PicoCreator opened 8 years ago
Note if anyone is "courageous" enough to actually want to skin the NaturalDocs.
Just create a branch of the documentation repo, create a new global CSS and JS, inject them into various pages and give it a try.
Once done, i can add the global CSS / JS to be injected as part of the build process
@PicoCreator Hey, have you seen Documentation.js?
I can work on integrating it, and skinning Natural Docs, if you'd like to change our stack to documentation.js. :laughing:
Here's an example(from their website): Example - documentation.js
@abhisheksoni27 : NaturalDocs being the bare minimum which I know works, is here really as a stop gap measure.
Redoing into a new documentation engine, is actually a viable option. Some major issues, is the lack of linking with types, nor the ability to properly declare static / non-static functions.
Never seen Documentation.js before, but its production example : https://www.mapbox.com/mapbox-gl-js/style-spec/ looks really good.
So perhaps? : Annoyingly for javascript, there are way too many engines out there, and what works / not wouldn't be apparently until it is already tried.
@PicoCreator Those major issues mean either we need to inject our own CSS/JS, or choose an engine which has the most number of features. And that, as you said, can only be seen once we try it.
I was also thinking about that cool custom CSS/JS
injection to NaturalDocs
, that you had earlier suggested.
But, thanks for sharing that, because docdash
looks beautiful. I found another one: minami
What do you think?
I like it
What about just using simple docs that are github readme.md only?
This: http://gpu.rocks/getting-started/
is over 9000 times better then
This: http://gpujs.github.io/dev-docs/
Problem is the former is manually created, the later is generated.
And so far from every JS documentation engine i use, they have quirks, or something off about it. NaturalDocs for all its "old-fashion" looks, works.
Basically we need to replace this or fix it.