remark-api

🐉 Note: this is new software doing complex things that hasn’t been used much. Here be dragons!

remark plugin to generate an API section.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
  • remarkApi() (default)
• Compatibility
• Thanks
• Contribute
• License

What is this?

This package is a unified (remark) plugin to generate am API section of a package such as the one below.

When should I use this?

This project is useful when you write readmes for npm packages typed with TypeScript. You can keep your docs in the code and have it automatically be pulled into the readme.

Install

This package is ESM only. In Node.js (version 18+), install with npm:

npm install remark-api

Use

See this repo. The format script in package.json runs remark, which includes in the remarkConfig settings this plugin remark-api, and generates:

API

remarkApi() (default)

Generate an API section.

Looks for the closest package.json file upwards from the current markdown file. For each export in the package, it generates API docs. It injects those into an # API section.

Parameters

There are no parameters.

Returns

Transform ((tree: Root, file: VFile) => Promise<undefined>).

Compatibility

This projects is compatible with maintained versions of Node.js.

When we cut a new major release, we drop support for unmaintained versions of Node. This means we try to keep the current release line, remark-api@1, compatible with Node.js 18.

Thanks

Special thanks go out to:

• @allmaps and Royal Netherlands Academy of Arts and Sciences (KNAW) for funding the initial development

Contribute

Yes please! See How to Contribute to Open Source.

License

MIT © Titus Wormer