docs: Jsdocs documentation

joshghent / query-stringifier

:question: A small library for build query strings

https://joshghent.github.io/query-stringifier/

MIT License

2 stars 2 forks source link

docs: Jsdocs documentation #11

Closed marcelorl closed 5 years ago

marcelorl commented 5 years ago

It should close #6

it includes:

Jsdocs documentation for each method
New npm script npm run docs which generates a new documentation within /docs folder
Contributing guidec

Please, in order to enable Github pages, just set master branch /docs folder in the repo Settings -> Git Pages section.

joshghent commented 5 years ago

Awesome job @marcelorl - this is great. And will allow us to expand the docs with ease. I wonder, do you know if there is a way to have the docs build automatically and pushed to the master branch?

marcelorl commented 5 years ago

Thank you @joshghent

Yes, I think a githook pre-commit (achieved with husky) would solve it. what do you think?

Then, whenever anyone commit anything, docs would be generated and added to that commit just created.

joshghent commented 5 years ago

@marcelorl Yeah that might be a good shout! Raise a separate issue for that. This is great work 👍

marcelorl commented 5 years ago

sure....Im opening this new issue.

Thank you.

marcelorl commented 5 years ago

dont forget to add it to your github pages.

then, you get something like this: https://marcelorl.github.io/query-stringifier/

haha

joshghent commented 5 years ago

@marcelorl It's up -> https://joshghent.github.io/query-stringifier/ Thanks dude, looks great Feel free to add this to the readme