Documentation cannot be generated about node-graphviz

[dawez]

Question: Would be possible to add the generated documentation directly to this repository?

[dummey]

I ended up using jsdoc and it's pretty usable (it also knows to pull in the readme.md for its index which is nice).

$ npm install -g jsdoc
$ jsdoc -r *

[whyboris]

I have just tried out jsdoc-to-markdown with this repository and got something sensible.

To replicate:

1. npm i jsdoc-to-markdown
2. add "scripts": { "doc": "jsdoc2md lib/deps/graph.js > doc.md" } to the package.json
3. run npm run doc 🤷
4. Open the doc.md file in something that can display markdown in a pretty way 😅

It's at least something 😉

[prantlf]

How about removing dox and using jsdoc-to-markdown? A generated API.md could be included in the repository.

[beatak]

I vote for this. And also dox doesn't support html anymore??? Not sure, but at the same time, there's jsdoc and it seems working well. What I did is:

find lib -name '*.js' -type f | xargs jsdoc

[callcter]

@beatak work!

[pacostas]

Hello, where i can find the documentation about this library?

[ChangXiaoning]

I also have the question: I just generate the file documentation.json using the command jake doc && open documentation.html. Why not add the documentation directly to this repository?

[n3h3m]

Oh please, give us the documentation like. The whole Jake project in Github gives 404 :p

[miparnisari]

dox doesn't support html anymore???

Apparently not... this is a bit of a problem. Not sure how to get documentation.json in a human-readable way...