Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Is there any API documentation available? #84

Closed
flovogt opened this issue May 16, 2020 · 2 comments
Closed

Is there any API documentation available? #84

flovogt opened this issue May 16, 2020 · 2 comments

Comments

@flovogt
Copy link

flovogt commented May 16, 2020

Hi team,
great work! I am getting started with oak these days and looking for some materials, like API documentation. Is there any official API documentation available?
All the best,
Florian

@flovogt flovogt changed the title Is there any API documentatio available Is there any API documentation available? May 16, 2020
@kitsonk
Copy link
Collaborator

kitsonk commented May 16, 2020

The README, and to a degree the /docs directory which is also https://oakserver.github.io/oak, plus all the code has inline documentation, and you can find auto generated documentation by clicking on the "deno doc" badge in the README, plus also the Deno's CLI supports auto documentation:

$ deno doc https://deno.land/x/oak/mod.ts

Not sure what else needs to be done.

@kitsonk kitsonk closed this as completed May 16, 2020
@flovogt
Copy link
Author

flovogt commented May 18, 2020

@kitsonk Thanks a lot. I missed the badge on the README directing to https://doc.deno.land/https/deno.land/x/oak/mod.ts.
That is what I was looking for. Maybee the link could also be placed in the README a second time as text.

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

No branches or pull requests

2 participants