Open jankapunkt opened 2 years ago
Okay I found this not to be so easy, since Github pages does not support .rst but only html and markdown.
I can provide a very easy way to generate markdown for the api from jsdoc using jsdoc-to-markdown
but the user documentation would need a different appraoch:
I personally favour second options, since many people know markdown and thus we have a greater reach of contribution.
This would be great, but a massive effort. I think this is something I can work on next.
Created the repo of https://github.com/node-oauth/node-oauth2-server-docs for user documentation to begin this transition
Hi guys, I see the docs repo is still empty.
How about to initial auto transform the rst to markdown and then commit it to the docs repo to start with?
It will allow for further refinements.
Thanks for such efforts.
Found this gist that can be helpful to start with https://gist.github.com/zaiste/77a946bbba73f5c4d33f3106a494e6cd
Hey @beeing that looks good. I would love to see a PR on this one as it looks pretty easy and would be a good chance for you to do your first contribution. I will accompany you with reviews and help.
We can easily host the docs on GH pages and we should to relfect our recent changes in the documentation, too.