x_team_doc

This repository combines several modern documentation tools into one example.

Included herein:

    (1) Swagger
    (2) JSDoc
    (3) Marked.js
    (4) Jekyll

Views

https://localhost:4444/views

    Main React client with links to all API endpoints

https://localhost:4444/views/markdown

    View marked.js from external sources

https://localhost:4444/views/markdown

    View marked.js from external sources

https://localhost:4444/swagger

    View a generated Swagger HTML

https://localhost:4444/pdf

    View a PDF

API Endpoints

https://localhost:4444/api/swagger/json

    Swagger JSON

https://localhost:4444/api/swagger/yaml

    Swagger YAML as a string

https://localhost:4444/api/swagger/yamljson

    Swagger YAML as JSON demonstrating interoperability of the two configuration types

https://localhost:4444/api/markdown

    Swagger JSON as a Markdown object

https://localhost:4444/api/pdf

    Swagger JSON parsed into PDF consummable JSON

https://localhost:4444/api/rest

    Example REST Endpoint for which Swagger was implemented

Hosted Swagger Endpoint

https://localhost:4444/swagger

    Example Swagger endpoint

PDF File Generation Endpoint

https://localhost:4444/pdf

    View a PDF of the generated Swagger!

How Do I Use This?

    $ npm run install
    $ npm run build
    $ npm run start

  $ npm install -g jsdoc

Licensing and Use

MIT Licensed.