open-index/open-npm huggingface dataset:
npm package: @infomaker/markdown-toc-parser
Description: Infomaker JS module: markdown-toc-parser
Author: Infomaker
Latest version: 0.1.2

# Infomaker markdown-toc-parser

## Installation
```
$ npm install --save @infomaker/markdown-toc-parser
```

## Usage

### Cli usage
Can be used to combine two tables of contents in markdown format into one.

If `output file` is specified, the combined TOC will be written to the specified file, otherwise `first file` will be overwritten.

```sh
@infomaker/merge-tocs <first file> <second file> [output file]
```

### Module usage
See the [API Reference](API.md).

## Develop the project

### Run the unit tests
```
docker-compose up
```

### Rebuild after updates to package.json
```
docker-compose down
docker-compose build
docker-compose up
```

### Support install of private Infomaker NPM modules

You need to add an `.env` file in root directory to be able to install Infomaker private npm modules. The file can be downloaded from 1Password, see 'JumpStart .env' in the Internal vault.

## Setup deploy Bitbucket Pipeline

This is an optional step if you want to use Bitbucket Pipeline to deploy the NPM lib to Infomakers organization on NPM.

Activate Bitbucket pipelines (in the web gui) and add the following environment variables in the web configuration gui for Pipeline:

```
NPM_TOKEN // for access to Infomakers NPM repos, copy from .env file
```
***