{"id":16944940,"url":"https://github.com/mattetti/custom-api-documenter","last_synced_at":"2025-04-13T20:52:22.004Z","repository":{"id":47047779,"uuid":"288584310","full_name":"mattetti/custom-api-documenter","owner":"mattetti","description":"Customized version of https://api-extractor.com/pages/setup/generating_docs/ allowing for more custom HTML/markdown API generation","archived":false,"fork":false,"pushed_at":"2021-05-12T17:20:42.000Z","size":602,"stargazers_count":1,"open_issues_count":1,"forks_count":3,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-05T02:17:06.662Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mattetti.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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-08-18T23:18:22.000Z","updated_at":"2020-10-27T22:14:06.000Z","dependencies_parsed_at":"2022-08-30T04:23:45.528Z","dependency_job_id":null,"html_url":"https://github.com/mattetti/custom-api-documenter","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mattetti%2Fcustom-api-documenter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mattetti%2Fcustom-api-documenter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mattetti%2Fcustom-api-documenter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mattetti%2Fcustom-api-documenter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mattetti","download_url":"https://codeload.github.com/mattetti/custom-api-documenter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248782283,"owners_count":21160716,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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-10-13T21:19:26.856Z","updated_at":"2025-04-13T20:52:21.984Z","avatar_url":"https://github.com/mattetti.png","language":"TypeScript","readme":"# @mattetti/custom-api-documenter a fork of @microsoft/api-documenter\r\n\r\nThis tool can be used to generate an online API reference manual for your TypeScript library.\r\nIt reads the *.api.json data files produced by [API Extractor](https://api-extractor.com/),\r\nand then generates files in [Markdown](https://en.wikipedia.org/wiki/Markdown) format with some HTML.\r\n\r\nFor usage information, see the\r\n[Generating Docs](https://api-extractor.com/pages/setup/generating_docs/) article from the API Extractor\r\ndocumentation.\r\n\r\n## Customization\r\n\r\nThe markdown renderer was customized to better render API docs using\r\n[hugo](https://gohugo.io/) and to allow for a different file structure.\r\n\r\nCustom json options not available in the original api-documenter markdown:\r\n\r\n- uriRoot: so the doc can generate links for api docs not hosted at the root of the domain.\r\n- onlyPackagesStartingWith: a string used to filter packages to document, useful when you want to publish only document some packages.\r\n\r\n\r\n```\r\n{\r\n  \"outputTarget\": \"markdown\",\r\n  \"newlineKind\": \"lf\",\r\n  \"uriRoot\": \"/apis\",\r\n  \"onlyPackagesStartingWith\": \"@mything\"\r\n}\r\n```\r\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmattetti%2Fcustom-api-documenter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmattetti%2Fcustom-api-documenter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmattetti%2Fcustom-api-documenter/lists"}