search

Surnet / swagger-jsdoc

Generates swagger/openapi specification based on jsDoc comments and YAML files.
MIT License
1.69k stars 228 forks source link

Docusaurus Documentation #324

Closed rockingrohit9639 closed 2 years ago

rockingrohit9639 commented 2 years ago

I have integrated a docusarus to move the documentation there.

Initially, I have put the documentation for version 5.x, if everything seems fine then I can process to create documentation for other versions.

Here is the URL of the live docusaurus documentation Live Demo

Issue #318

@daniloab

daniloab commented 2 years ago

@rockingrohit9639 can you fix the problems?

rockingrohit9639 commented 2 years ago

@daniloab can you please tell me how can I solve these test errors? I have not made any changes in any files other than docusaurus, but it is still throwing errors.

daniloab commented 2 years ago

can we have prints of how is going the docs?

rockingrohit9639 commented 2 years ago

can we have prints of how is going the docs?

You can see the live preview of docs here Live Preview It is only for version 5.x, I can add docs for more versions if everything is good with this initial setup.

Here is a demo of the docs swagger-jsdoc

daniloab commented 2 years ago

can we have prints of how is going the docs?

You can see the live preview of docs here Live Preview It is only for version 5.x, I can add docs for more versions if everything is good with this initial setup.

Here is a demo of the docs swagger-jsdoc swagger-jsdoc

Looking awesome! Lets move forward

rockingrohit9639 commented 2 years ago

can we have prints of how is going the docs?

You can see the live preview of docs here Live Preview It is only for version 5.x, I can add docs for more versions if everything is good with this initial setup. Here is a demo of the docs swagger-jsdoc

    [

        ![swagger-jsdoc](https://user-images.githubusercontent.com/40729749/182613967-620bca96-abc9-4984-bc5b-839f4a6517a9.gif)

    ](https://user-images.githubusercontent.com/40729749/182613967-620bca96-abc9-4984-bc5b-839f4a6517a9.gif)

      [

      ](https://user-images.githubusercontent.com/40729749/182613967-620bca96-abc9-4984-bc5b-839f4a6517a9.gif)

   [ ![swagger-jsdoc](https://user-images.githubusercontent.com/40729749/182613967-620bca96-abc9-4984-bc5b-839f4a6517a9.gif) ](https://user-images.githubusercontent.com/40729749/182613967-620bca96-abc9-4984-bc5b-839f4a6517a9.gif)

    [

        ![swagger-jsdoc](https://user-images.githubusercontent.com/40729749/182613967-620bca96-abc9-4984-bc5b-839f4a6517a9.gif)

    ](https://user-images.githubusercontent.com/40729749/182613967-620bca96-abc9-4984-bc5b-839f4a6517a9.gif)

      [

      ](https://user-images.githubusercontent.com/40729749/182613967-620bca96-abc9-4984-bc5b-839f4a6517a9.gif)

   [ ](https://user-images.githubusercontent.com/40729749/182613967-620bca96-abc9-4984-bc5b-839f4a6517a9.gif)

Looking awesome! Lets move forward

Ok, I will be adding docs for other versions now.

daniloab commented 2 years ago

sure, do you prefer send in another pr or still in this one?

rockingrohit9639 commented 2 years ago

sure, do you prefer send in another pr or still in this one?

I can do as you want.

daniloab commented 2 years ago

lets move forward in another pull request

rockingrohit9639 commented 2 years ago

lets move forward in another pull requests

Okay, great.