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

Better looking natural docs #19

Open
PicoCreator opened this issue Feb 28, 2016 · 7 comments
Open

Better looking natural docs #19

PicoCreator opened this issue Feb 28, 2016 · 7 comments

Comments

@PicoCreator
Copy link
Contributor

@PicoCreator PicoCreator commented Feb 28, 2016

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.

@PicoCreator PicoCreator changed the title Bette looking natural docs Better looking natural docs Feb 28, 2016
@PicoCreator PicoCreator added this to the who-knows-when-beta milestone Feb 28, 2016
@PicoCreator
Copy link
Contributor Author

@PicoCreator PicoCreator commented Feb 28, 2016

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

@abhisheksoni27
Copy link
Contributor

@abhisheksoni27 abhisheksoni27 commented Jul 1, 2017

@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. 😆

Here's an example(from their website): Example - documentation.js

@PicoCreator
Copy link
Contributor Author

@PicoCreator PicoCreator commented Jul 2, 2017

@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
Copy link
Contributor Author

@PicoCreator PicoCreator commented Jul 2, 2017

Theres also jsdoc with templates like docdash

@abhisheksoni27
Copy link
Contributor

@abhisheksoni27 abhisheksoni27 commented Jul 2, 2017

@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?

@robertleeplummerjr
Copy link
Member

@robertleeplummerjr robertleeplummerjr commented Oct 7, 2017

I like it

@robertleeplummerjr
Copy link
Member

@robertleeplummerjr robertleeplummerjr commented Nov 18, 2017

What about just using simple docs that are github readme.md only?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
3 participants
You can’t perform that action at this time.