docsify icon indicating copy to clipboard operation
docsify copied to clipboard

API Reference

Open anishanne opened this issue 5 years ago • 3 comments

Feature request

What problem does this feature solve?

Ability to use docsify as for API documentation.

How should this be implemented in your opinion?

Something like gitbook. image

Are you willing to work on this yourself?

Unable to.

anishanne avatar Jun 28 '20 21:06 anishanne

of cause u can use docsify as API documentation. I dont understand what u meant about gitbook. do u wanna the same theme or style like gitbook?

Koooooo-7 avatar Jul 02 '20 15:07 Koooooo-7

if u wanna a tab like u posted , I think u can use this plugin(docsify-tabs).

Koooooo-7 avatar Jul 02 '20 15:07 Koooooo-7

@anishanne Docsify is a simple easy-to-use documentation "renderer" rather than a "generator". The documentation is not generated by docsify, you still have to write the markdown files. Docsify just makes it easy for you to render those .md files into a beautiful UI that can be deployed and published onto the web.

Docsify covers the ability to use it for wide variety of documentation purposes. You can most certainly use it to create documentation for your API. I am assuming you are referring to the documentation being generated automatically for your API endpoints (assuming since you weren't elaborate on your issue), if that's the case then you should look into something like Swagger API Documentation which deals primarily with API documentation and automatically generating them.

aemmadi avatar Jul 02 '20 15:07 aemmadi