A full version history of the remark-api package with size, number of distributed files and dependency evolution.
remark-api is a remark plugin designed to automatically generate API sections within markdown documents. This tool streamlines documentation workflows by extracting API information directly from code, ensuring accuracy and reducing manual updates. The package offers two notable versions, 1.0.0 and 1.1.0, each bringing improvements to the core functionality.
Version 1.0.0 laid the foundation, providing essential dependencies such as @types/mdast, mdast-util-heading-range, module-exports, package-exports, vfile, and vfile-find-up to handle markdown parsing, heading manipulation, module exports analysis, and file system operations. Development dependencies included tools for testing, code formatting (Prettier), linting (XO), and TypeScript support, ensuring code quality and maintainability.
Version 1.1.0 built on this foundation by introducing @types/unist and vfile-message as dependencies. The addition of @types/unist suggests enhanced support for unified syntax trees, potentially offering broader compatibility with different markdown structures. The inclusion of vfile-message hints at improved error reporting and diagnostic capabilities within the plugin. The upgrade signifies a commitment to better handling diverse markdown formats and providing more informative messages during API documentation generation. Both versions share the same core goal of automating API documentation with remark, while 1.1.0 appears to offer expanded support and refined error handling.