Skip to content

Better looking natural docs #19

@PicoCreator

Description

@PicoCreator
Contributor

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.

Activity

changed the title [-]Bette looking natural docs[/-] [+]Better looking natural docs[/+] on Feb 28, 2016
PicoCreator

PicoCreator commented on Feb 28, 2016

@PicoCreator
ContributorAuthor

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

abhisheksoni27 commented on Jul 1, 2017

@abhisheksoni27
Contributor

@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

PicoCreator commented on Jul 2, 2017

@PicoCreator
ContributorAuthor

@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

PicoCreator commented on Jul 2, 2017

@PicoCreator
ContributorAuthor

Theres also jsdoc with templates like docdash

abhisheksoni27

abhisheksoni27 commented on Jul 2, 2017

@abhisheksoni27
Contributor

@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

robertleeplummerjr commented on Oct 7, 2017

@robertleeplummerjr
Member

I like it

robertleeplummerjr

robertleeplummerjr commented on Nov 18, 2017

@robertleeplummerjr
Member

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

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @robertleeplummerjr@abhisheksoni27@PicoCreator

        Issue actions

          Better looking natural docs · Issue #19 · gpujs/gpu.js