What is the tool for generating and centralized storage of documentation on the source code?

  • 0
    Then in the evening I had the idea to combine all the documentation on projects that are being conducted in our organization into a single database and form a small website on its basis with the display of this information, a convenient search and examples.

    At the moment, we generate documentation through PhpDocumentor and store it next to the source code. This option is no longer very suitable.

    The nuance is that the system must work locally without external access.

    Who faced this or a similar problem? Can there be a sensible instrument in the open?
    JavaScript Anonymous, Mar 25, 2020

  • 2 Answers
  • 0
    Saw the site, even on the same Bitrix and place it locally. You can even write it down to a USB flash drive if you want and then always carry it with you:

    https://usbwebserver.yura.mk.ua/en.php
    Arya Morton

  • 0
    I advise you to look towards Swagger and ReDoc.



    In short:



    you write all the documentation in one json file in Swagger-OpenAPI format.

    Then you write a short html that picks up ReDoc and feeds it your json. Then it all turns into beautiful docks. Html example:



    <!DOCTYPE html>
    <html lang="en">
    <head>
    <title>My API</title>
    <meta charset="utf-8"/>
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <meta name="robots" content="noindex,nofollow" />
    <link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">
    <style>
    body {
    margin: 0;
    padding: 0;
    }
    </style>
    </head>
    <body>
    <script>
    <redoc spec-url="my-api.json"></redoc>
    </script>
    <script src="https://cdn.jsdelivr.net/npm/[email protected]/bundles/redoc.standalone.js"> </script>
    </body>
    </html>
    Anonymous

Your Answer
To place the code, please use CodePen or similar tool. Thanks you!