{"id":15413433,"url":"https://github.com/wooorm/remark-api","last_synced_at":"2025-04-19T03:19:48.700Z","repository":{"id":237958545,"uuid":"795577461","full_name":"wooorm/remark-api","owner":"wooorm","description":"remark plugin to generate an API section","archived":false,"fork":false,"pushed_at":"2024-05-21T11:17:07.000Z","size":22,"stargazers_count":14,"open_issues_count":4,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-12T15:09:57.124Z","etag":null,"topics":["api","docs","remark","remark-plugin","unified"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/wooorm.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":"funding.yml","license":"license","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"wooorm"}},"created_at":"2024-05-03T15:23:05.000Z","updated_at":"2025-03-22T11:16:44.000Z","dependencies_parsed_at":"2024-10-23T01:51:21.728Z","dependency_job_id":"0da8b716-56e4-4f42-b6a0-c0183060b946","html_url":"https://github.com/wooorm/remark-api","commit_stats":{"total_commits":7,"total_committers":1,"mean_commits":7.0,"dds":0.0,"last_synced_commit":"f46bca0f7f8428290298fb87a604d07ca51dab3d"},"previous_names":["wooorm/remark-api"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wooorm%2Fremark-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wooorm%2Fremark-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wooorm%2Fremark-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wooorm%2Fremark-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wooorm","download_url":"https://codeload.github.com/wooorm/remark-api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249598386,"owners_count":21297464,"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":["api","docs","remark","remark-plugin","unified"],"created_at":"2024-10-01T16:57:03.284Z","updated_at":"2025-04-19T03:19:48.672Z","avatar_url":"https://github.com/wooorm.png","language":"JavaScript","funding_links":["https://github.com/sponsors/wooorm"],"categories":[],"sub_categories":[],"readme":"# remark-api\n\n[![Build][badge-build-image]][badge-build-url]\n[![Coverage][badge-coverage-image]][badge-coverage-url]\n[![Downloads][badge-downloads-image]][badge-downloads-url]\n\n\u003e 🐉 **Note**: this is new software doing complex things that hasn’t been used\n\u003e much.\n\u003e Here be dragons!\n\n**[remark][github-remark]** plugin to generate an API section.\n\n## Contents\n\n* [What is this?](#what-is-this)\n* [When should I use this?](#when-should-i-use-this)\n* [Install](#install)\n* [Use](#use)\n* [API](#api)\n  * [`remarkApi() (default)`](#remarkapi-default)\n* [Compatibility](#compatibility)\n* [Thanks](#thanks)\n* [Contribute](#contribute)\n* [License](#license)\n\n## What is this?\n\nThis package is a [unified][github-unified] ([remark][github-remark]) plugin\nto generate am API section of a package such as the one below.\n\n## When should I use this?\n\nThis project is useful when you write readmes for npm packages typed with\nTypeScript.\nYou can keep your docs in the code and have it automatically be pulled into the\nreadme.\n\n## Install\n\nThis package is [ESM only][github-gist-esm].\nIn Node.js (version 18+), install with [npm][npm-install]:\n\n```sh\nnpm install remark-api\n```\n\n## Use\n\nSee this repo.\nThe `format` script in `package.json` runs `remark`,\nwhich includes in the `remarkConfig` settings this plugin `remark-api`,\nand generates:\n\n## API\n\n### `remarkApi() (default)`\n\nGenerate an API section.\n\nLooks for the closest `package.json` file upwards from the current\nmarkdown file.\nFor each export in the package, it generates API docs.\nIt injects those into an `# API` section.\n\n###### Parameters\n\nThere are no parameters.\n\n###### Returns\n\nTransform (`(tree: Root, file: VFile) =\u003e Promise\u003cundefined\u003e`).\n\n## Compatibility\n\nThis projects is compatible with maintained versions of Node.js.\n\nWhen we cut a new major release, we drop support for unmaintained versions of\nNode.\nThis means we try to keep the current release line, `remark-api@1`,\ncompatible with Node.js 18.\n\n## Thanks\n\nSpecial thanks go out to:\n\n* [**@allmaps**][github-allmaps] and\n  [Royal Netherlands Academy of Arts and Sciences (KNAW)][knaw]\n  for funding the initial development\n\n## Contribute\n\nYes please!\nSee [How to Contribute to Open Source][open-source-guide-contribute].\n\n## License\n\n[MIT][file-license] © [Titus Wormer][wooorm]\n\n\u003c!-- Definitions --\u003e\n\n[badge-build-image]: https://github.com/wooorm/remark-api/actions/workflows/main.yml/badge.svg\n\n[badge-build-url]: https://github.com/wooorm/remark-api/actions\n\n[badge-coverage-image]: https://img.shields.io/codecov/c/github/wooorm/remark-api.svg\n\n[badge-coverage-url]: https://codecov.io/github/wooorm/remark-api\n\n[badge-downloads-image]: https://img.shields.io/npm/dm/remark-api.svg\n\n[badge-downloads-url]: https://www.npmjs.com/package/remark-api\n\n[file-license]: license\n\n[github-gist-esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c\n\n[github-allmaps]: https://github.com/allmaps\n\n[github-remark]: https://github.com/remarkjs/remark\n\n[github-unified]: https://github.com/unifiedjs/unified\n\n[knaw]: https://www.knaw.nl/en\n\n[npm-install]: https://docs.npmjs.com/cli/install\n\n[open-source-guide-contribute]: https://opensource.guide/how-to-contribute/\n\n[wooorm]: https://wooorm.com\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwooorm%2Fremark-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwooorm%2Fremark-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwooorm%2Fremark-api/lists"}