{"id":21637836,"url":"https://github.com/alicfeng/apidoc-markdown","last_synced_at":"2026-05-01T18:32:31.052Z","repository":{"id":56945587,"uuid":"278678778","full_name":"alicfeng/apidoc-markdown","owner":"alicfeng","description":"基于 apidoc 工具生成的接口文档转 markdown 文档","archived":false,"fork":false,"pushed_at":"2021-07-22T09:07:28.000Z","size":15,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-11-27T14:36:33.267Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","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/alicfeng.png","metadata":{"files":{"readme":"README.md","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":"2020-07-10T16:12:40.000Z","updated_at":"2021-07-22T09:07:31.000Z","dependencies_parsed_at":"2022-08-21T07:50:57.081Z","dependency_job_id":null,"html_url":"https://github.com/alicfeng/apidoc-markdown","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/alicfeng/apidoc-markdown","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alicfeng%2Fapidoc-markdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alicfeng%2Fapidoc-markdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alicfeng%2Fapidoc-markdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alicfeng%2Fapidoc-markdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alicfeng","download_url":"https://codeload.github.com/alicfeng/apidoc-markdown/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alicfeng%2Fapidoc-markdown/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32508901,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-30T13:12:12.517Z","status":"online","status_checked_at":"2026-05-01T02:00:05.856Z","response_time":64,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":"2024-11-25T04:07:07.767Z","updated_at":"2026-05-01T18:32:31.028Z","avatar_url":"https://github.com/alicfeng.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# apidoc_markdown\n基于 `apidoc` 工具生成的接口文档转 `markdown` 文档\n\n## 前言\n使用 `apidoc` 工具生成接口文档，其实已经满足接口文档查阅所需，然而接口文档被按照统一格式维护与管理(对外-markdown)，为满足😌两者共存，于是就出现了 `apidoc-markdown` 😁其实已经有一个 `apidoc-markdown` 这样的扩展 `npm install -g apidoc-markdown`,只是不满足所需，刚需 - 结合 `docsify` 而用。\n\n## 安装\n\n- [x] `composer` 安装\n```shell\ncomposer require alicfeng/apidoc-markdown --dev -vvv\n```\n\n- [x] `shell` 安装\n```shell\nwget https://github.com/alicfeng/apidoc-markdown/raw/master/bin/apidoc_markdown -O /usr/local/sbin/apidoc_markdown \u0026\u0026 chmod a+x /usr/local/sbin/apidoc_markdown\n```\n\n## 使用\n#### 帮助使用\n```shell\n➜ vendor/bin/apidoc_markdown -h\nUsage: apidoc_markdown [options...]\n-i    input directory  \n-o    output directory \n\n# OR\n\n➜ apidoc_markdown -h\nUsage: apidoc_markdown [options...]\n-i    input directory  \n-o    output directory \n\n\n```\n\n#### 导出使用\n```shell\n➜ vendor/bin/apidoc_markdown -i {input} -o {output}\n\n# OR\n\n➜ apidoc_markdown -i {input} -o {output}\n```\n\n#### 效果实例\n```shell\n➜  apidoc-markdown git:(master) ✗ apidoc_markdown -i ~/tutorial/github/api.samego.com/document -o docs\n➜  apidoc-markdown git:(master) ✗ tree docs                                                                          \ndocs\n├── documents\n│   ├── Algo.md\n│   ├── Camera.md\n│   ├── Device.md\n│   ├── Federal.md\n│   ├── Offline.md\n│   ├── Online.md\n│   ├── Rule.md\n│   ├── System.md\n│   └── User.md\n└── _sidebar.md\n\n1 directory, 10 files\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falicfeng%2Fapidoc-markdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falicfeng%2Fapidoc-markdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falicfeng%2Fapidoc-markdown/lists"}