@2gis/ts-docs-generator v0.1.0

TS docs generator

Documentation generator for TypeScript projects of 2GIS.

Installation

npm i @2gis/ts-docs-generator

Usage

CommonJS

const { generateDocs } = require("@2gis/ts-docs-generator");

generateDocs(config).then((result) => {
    // Access generated documentation
    // result.manifest - Contains metadata about the documentation
    // result.reference - Contains the generated API documentation
});

Development

# Install dependencies
npm install

# Run tests
npm test

# Build the project
npm run build

Release Process

To release a new version:

1. Create a tag vX.Y.Z in GitLab (where X.Y.Z is the semantic version number)
2. Push the tag to the repository
3. The CI/CD pipeline will automatically build and publish the package