Skip to content
This repository has been archived by the owner on Nov 3, 2021. It is now read-only.

Add documentation generation to package.info #67

Open
rmhrisk opened this issue Aug 27, 2016 · 4 comments
Open

Add documentation generation to package.info #67

rmhrisk opened this issue Aug 27, 2016 · 4 comments

Comments

@rmhrisk
Copy link
Contributor

rmhrisk commented Aug 27, 2016

We can add generation of derived documentation via tsdoc/typedoc or similar then apply fork of docdash: https://github.com/clenemt/docdash

"script": {
"generate-docs": "node_modules/.bin/jsdoc -c jsdoc.json"
}
This way we can have standalone documentation showing how to use the library.

@hildjj
Copy link
Contributor

hildjj commented Sep 1, 2016

Presumably, you want to use typedoc or tsdoc, not jsdoc? I don't know if the docdash theme will work with the output of either of those.

@rmhrisk
Copy link
Contributor Author

rmhrisk commented Sep 1, 2016

I was a bit over zealous with copy and paste, the goal is to have generated documents.

If the Docdash theme will not work we have some guys we can make one that is visually similar that will work with typedoc/tsdoc.

Do you have experience with either?

@hildjj
Copy link
Contributor

hildjj commented Sep 1, 2016

No. They both look... early.

@rmhrisk
Copy link
Contributor Author

rmhrisk commented Sep 1, 2016

Agreed, was hoping you might be able to provide assurance it was OK :)

@rmhrisk rmhrisk changed the title JSDOC: Add documentation generation to package.info Add documentation generation to package.info Sep 1, 2016
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants