Generating index page

635 views
Skip to first unread message

Tim Statler

unread,
Nov 22, 2011, 2:29:57 PM11/22/11
to JSDoc Users
If I recall correctly, the default template of JSDoc Toolkit generated
a index page of documented classes/objects. Anyone know of a custom
JSDoc 3 template that does this?

thanks,
Tim

Michael

unread,
Nov 22, 2011, 2:46:22 PM11/22/11
to tim.s...@gmail.com, JSDoc Users
Hi Tim,

You are right about the index page in JSDoc Toolkit. It would be great to add such a page to the default template for JSDoc 3. Your question is good: if there are any out there maybe I can adapt it to work in JSDoc 3.

--
m

> --
> You received this message because you are subscribed to the Google Groups "JSDoc Users" group.
> To post to this group, send email to jsdoc...@googlegroups.com.
> To unsubscribe from this group, send email to jsdoc-users...@googlegroups.com.
> For more options, visit this group at http://groups.google.com/group/jsdoc-users?hl=en.
>

Alex Tanasiychuk

unread,
Jan 5, 2012, 4:42:39 AM1/5/12
to JSDoc Users
Hi Michael,

I'm new to JSDoc, I'm trying to use JSDoc 3, I also saw the problem of
missing index page.

Is there anything new about it?

I would also want to know if there is a repository of templates I can
try?


Thanks,

Alex

On Nov 22 2011, 9:46 pm, Michael <micm...@gmail.com> wrote:
> Hi Tim,
>
> You are right about the index page in JSDoc Toolkit. It would be great to add such a page to the default template for JSDoc 3. Your question is good: if there are any out there maybe I can adapt it to work in JSDoc 3.
>
> --
> m
>

Michael Mathews

unread,
Jan 5, 2012, 9:26:28 AM1/5/12
to Alex Tanasiychuk, JSDoc Users
I personally haven't done any work yet on creating an index page, but I am happy to accept pull requests.

Also I have not yet created a gallery of templates (there is only 1 at the moment, as far as I know) but maybe some others on this list might share their templates?

Michael Mathews
mic...@gmail.com

theallan

unread,
Jan 12, 2012, 8:35:56 AM1/12/12
to JSDoc Users
My own DataTables template does ToC generation:

Example: http://datatables.net/docs/
Template: https://github.com/DataTables/JSDoc-DataTables

It almost certainly isn't perfect, but it might be of interest, or at
least provide a starting point for anyone else interested in creating
their own :-)

Allan


On Jan 5, 2:26 pm, Michael Mathews <micm...@gmail.com> wrote:
> I personally haven't done any work yet on creating an index page, but I am happy to accept pull requests.
>
> Also I have not yet created a gallery of templates (there is only 1 at the moment, as far as I know) but maybe some others on this list might share their templates?
>
> Michael Mathews
> micm...@gmail.com

Andreas Wehr

unread,
Jan 13, 2012, 4:59:50 AM1/13/12
to JSDoc Users
Hi,
Until an index page is build into the template out of the box, I use
rake to build one after the documentation was generated (I had no time
yet to look into the templating of jsdoc)

I use an erb template for the index file and simply list all html
files found in the generated documenation.

Andreas
Reply all
Reply to author
Forward
0 new messages