open-index/open-npm huggingface dataset:
npm package: @2gis/js-docs-generator
Description: Documentation generator for 2GIS JS projects
Author: 2GIS WebMaps Team
Latest version: 0.0.3

# JS docs generator

Documentation generator for JS projects of 2GIS.

## Usage

```bash
npm i @2gis/js-docs-generator
```

Inside Common JS module:

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

generateDocs(config).then((result) => {
    // result.manifest
    // result.reference
});
```
npm package: @2gis/mapgl
Description: MapGL API script loader with typings
Latest version: 1.72.0

# @2gis/mapgl

Async loader for [2gis MapGL API](https://docs.2gis.com/en/mapgl/overview) with typings.

**Browser usage only!**

## Installation

```
$ npm install @2gis/mapgl
```

## Usage

```typescript
import { load } from '@2gis/mapgl';
// or const { load } = require('@2gis/mapgl');

async function start() {
    const mapglAPI = await load();

    // container — id of the div element in your html
    const map = new mapglAPI.Map('container', {
        center: [55.31878, 25.23584],
        zoom: 13,
        key: 'Your API access key',
    });

    const marker = new mapglAPI.Marker(map, {
        coordinates: [55.31878, 25.23584],
    });
}

start();
```

**Without await/async:**

```typescript
load().then((mapglAPI) => {
    const map = new mapglAPI.Map('container', {
        center: [55.31878, 25.23584],
        zoom: 13,
        key: 'Your API access key',
    });
});
```

By default, `latest` version of MapGL API will be loaded (`https://mapgl.2gis.com/api/js`). But you can specify certain version of MapGL API to load:

```typescript
load('https://mapgl.2gis.com/api/js/v1.4.2').then((mapglAPI) => {});
```

Checkout our [release notes for MapGL API](https://docs.2gis.com/en/mapgl/overview/releases). Important to note, mapgl loader version is not equal to MapGL API version, cause it has its own features.

## mapgl namespace

@2gis/mapgl exports `load` function and `global.d.ts` file which you can reference to have access to mapgl typings.

To use types from mapgl namespace you need:

1. Add reference to node_modules/@2gis/mapgl/global.d.ts in your project.d.ts
1. Or reference in a module, where `load` function is imported

```typescript
/// <reference path="node_modules/@2gis/mapgl/global.d.ts" />
```

You can use typings for MapGL from mapgl namespace like this:

```typescript
let marker: mapgl.Marker
```

Checkout example for more information.
npm package: @2gis/mapgl-directions
Description: Driving directions plugin for Mapgl
Latest version: 2.2.1

# mapgl-directions

Driving directions plugin for [Mapgl](https://docs.2gis.com/en/mapgl/overview)

### Релиз

1. Поставить тэг в [release-maester](http://webmaps.gitlab-pages.2gis.io/release-maester/index.html#/notes?project=mapgl-directions)
2. Запустить пайплайн на созданом тэге
npm package: @2gis/mapgl-gltf
Description: Plugin for the rendering glTF models with MapGL
Author: 2GIS WebMaps Team
Latest version: 1.5.0

# mapgl-gltf

Plugin for the rendering glTF models with MapGL

## The basic usage via npm package

Install `@2gis/mapgl` and `@2gis/mapgl-gltf` packages:

```shell
npm install @2gis/mapgl
npm install @2gis/mapgl-gltf
```

Import mapgl and plugin into your project:

```js
import { load } from '@2gis/mapgl';
import { GltfPlugin } from '@2gis/mapgl-gltf';

const mapglAPI = await load();

const map = new mapglAPI.Map('container', {
    center: [82.886554, 54.980988],
    zoom: 18,
});

const plugin = new GltfPlugin(map);
plugin.addModels([{
    modelId: '03a234cb',
    coordinates: [82.886554, 54.980988],
    modelUrl: 'models/cube_draco.glb',
    rotateX: 90,
    scale: 1000,
    linkedIds: ['141373143530065', '70030076379181421'],
}]);
```

## Release

1. Update the package version by running `npm version patch|minor|major`. This command returns a new package version. Let assume it's 1.2.3
1. Push changes to github and merge them to the «master» branch
1. Go to https://github.com/2gis/mapgl-gltf/releases/new
1. Click the «Choose tag» button and create a new tag according to the version in package.json, for example v1.2.3
1. Make sure the release target is the «master» branch
1. Paste the release tag into the «Release title» field, for example v1.2.3
1. Add a release description
1. Click the «Publish release» button
1. Go to https://github.com/2gis/mapgl-gltf/actions and wait for completing the release workflow

## Testing

If you write screenshot tests, you will need run `npm run docker:test` after coding.
This command runs your tests on the docker image that is used in pipeline build.
This guarantees the authenticity of the screenshots used.

## Documentation

You can find the more information in the official [documentation](https://docs.2gis.com/en/mapgl/immersive/gltf-plugin).
npm package: @2gis/markerdrawer
Description: Library for fast drawing a huge amount of markers
Author: Mstislav Zhivodkov
Latest version: 1.1.0

# MarkerDrawer [![Build Status](https://travis-ci.org/2gis/markerdrawer.svg?branch=master)](https://travis-ci.org/2gis/markerdrawer)

Library for fast drawing a huge amount of markers

[Demo](https://2gis.github.io/markerdrawer/)

## Release
1. `npm version patch` – update version
2. `git push --follow-tags` – push commit to github
2. `rm -rf dist && npm run build` – build the project
3. `npm publish` – publish to npm