nodeca/ndoc — Issue #36: Integrate Cloud9 ndoc changes
Author: gjtorikian
Created: 2012-02-03 06:35:41+00:00
State: open

I was hoping that you would consider merging changes to ndoc I have made in a fork back into the main ndoc library. I know the standard etiquette here would be to make a pull request, but there are really too many difference for any one merge to make sense.

The list of changes can be found on [the README](https://github.com/c9/ndoc/blob/master/README.md). Right now, the ndoc fork is being used in [http://www.nodemanual.org]; pretty soon, another variant of it will be used [by Joyent for their API](https://github.com/joyent/node/pull/2645).

At a high-level, here are the changes I've made:

* Creating a separate page for every class, including support for "[[ ]]"-notation linking
* Adding "ellipsis" descriptions, truncating the full doc into 120 characters.
* Linkifying everything (object types in arguments, return types, e.t.c.)
* Allowing the same dirname for output to exist
* Better support for non-js files; for .md or .markdown files, this ndoc adds "*" prefixes to continue to support parsing
* Allowing to specify a URL to retrieve Javascript documentation about global objects
* Changes to the source directory structure
* Linking out to Javascript documentation
* Support for conrefs

The giant catch here is that every one of these needs to be implemented, as they're currently being in used in various projects. I can go through the code and try to make separate pull requests for the changes, as best as I can remember.

I understand if this is not something that interests the ndoc team, but, I thought I would make the suggestion anyway. Thanks for reading!