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

Put full docs online #3

Closed
lorensr opened this issue Mar 24, 2015 · 3 comments
Closed

Put full docs online #3

lorensr opened this issue Mar 24, 2015 · 3 comments

Comments

@lorensr
Copy link

lorensr commented Mar 24, 2015

You can generate html documentation by running the command:

npm install && npm run docs

Open generated html files in docs/ dir with a browser.

It would be nice if there was a public website with this, linked to in the README

@jorilallo
Copy link
Contributor

@lorensr This would be nice but it doesn't seem that docco has support for generating index.html. There might be some other module that helps. I'll leave this open until I have time to research this but if you have time, take a stab at it and I'm happy to push them out as GitHub Pages.

@lorensr
Copy link
Author

lorensr commented Mar 24, 2015

I see. This might work:

https://github.com/mbrevoort/docco-husky

And here's an open FR:

DavidSouther/grunt-docco#31

@jorilallo
Copy link
Contributor

Thanks, I'll have to take a look little later as I want to be sure that we don't blow up requirements (docco is really small as is).

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Development

No branches or pull requests

2 participants