{"id":42212893,"url":"https://github.com/foliant-docs/apidoc2markdown","last_synced_at":"2026-01-27T01:06:52.772Z","repository":{"id":57410885,"uuid":"75628582","full_name":"foliant-docs/apidoc2markdown","owner":"foliant-docs","description":"Converter from Apidoc JSON to Markdown","archived":false,"fork":false,"pushed_at":"2016-12-07T13:01:59.000Z","size":3,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-09-30T02:21:18.001Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/foliant-docs.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-12-05T13:43:33.000Z","updated_at":"2019-05-18T03:52:06.000Z","dependencies_parsed_at":"2022-08-28T01:14:07.996Z","dependency_job_id":null,"html_url":"https://github.com/foliant-docs/apidoc2markdown","commit_stats":null,"previous_names":["moigagoo/apidoc2markdown"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/foliant-docs/apidoc2markdown","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/foliant-docs%2Fapidoc2markdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/foliant-docs%2Fapidoc2markdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/foliant-docs%2Fapidoc2markdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/foliant-docs%2Fapidoc2markdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/foliant-docs","download_url":"https://codeload.github.com/foliant-docs/apidoc2markdown/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/foliant-docs%2Fapidoc2markdown/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28794641,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-26T21:49:50.245Z","status":"ssl_error","status_checked_at":"2026-01-26T21:48:29.455Z","response_time":59,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-01-27T01:06:52.260Z","updated_at":"2026-01-27T01:06:52.758Z","avatar_url":"https://github.com/foliant-docs.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"###############\napidoc2markdown\n###############\n\nApidoc_ is an open specification for documenting REST APIs in JSON or YAML.\nImperfect as it is, it's de facto a standard for many API developers.\n\nThis extension lets you render your swagger.json file as a Markdown document.\nYou can customize the output by providing your own Jinja2_ template.\n\n.. important::\n\n    For best results, disable Markdown processing when building Apidoc files:\n\n    .. code-block:: shell\n\n        $ apidoc -o docs -i myproject --markdown false # \u003c- Do this.\n        $ apidoc -o docs -i myproject                  # \u003c- Instead of this.\n\n    This way your markup will be preserved in the final Markdown output.\n\n.. _Apidoc: http://apidocjs.com/\n.. _Jinja2: http://jinja.pocoo.org/\n\n\n.. warning::\n\n    This extension was created for a particular project and thus is only\n    guaranteed to work with this particular project! It is very much likely\n    you'll have to modify apidoc.md.j2_ for your project.\n\n.. _apidoc.md.j2: https://github.com/moigagoo/apidoc2markdown/blob/master/apidoc.md.j2\n\n\n************\nInstallation\n************\n\n.. code-block:: shell\n\n    $ pip install apidoc2markdown\n\n\n*****\nUsage\n*****\n\n.. code-block:: shell\n\n    usage: apidoc2markdown-script.py [-h] [-i APIDOC_LOCATION] [-o OUTPUT]\n                                    [-t TEMPLATE]\n\n    optional arguments:\n      -h, --help            show this help message and exit\n      -i APIDOC_LOCATION, --input APIDOC_LOCATION\n                            path to the directory with api_data.json\n                            and api_project.json (default: .)\n      -o OUTPUT, --output OUTPUT\n                            path to the output Markdown file (default: swagger.md)\n      -t TEMPLATE, --template TEMPLATE\n                            Jinja2 template used for conversion\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffoliant-docs%2Fapidoc2markdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffoliant-docs%2Fapidoc2markdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffoliant-docs%2Fapidoc2markdown/lists"}