<commit_before># Ballad

Assemble API Blueprint specifications with concatenation, templating, and inheritance.

Ballad is designed to write API documentation quickly and easily, using composition and 
keeping things [DRY](https://en.wikipedia.org/wiki/Don%27t_repeat_yourself).

Each component of your specifications should be written with the [API Blueprint](https://apiblueprint.org/) 
format. [Check out how to write Blueprints here](https://docs.apiary.io/api_101/api_blueprint_tutorial/).

Ballad was build with the [spoke-hub distribution paradigm](https://en.wikipedia.org/wiki/Spoke%E2%80%93hub_distribution_paradigm) 
in mind, meaning it easily allows the creation of API specifications derived from a base one, in an object-oriented manner.

# Table of Contents
  1. [Installation](#installation)
  2. [Setting Up a Spec](#setting-up-a-spec)
  3. [JSON Helpers](#json-helpers)
  4. [Usage Examples](#usage-examples)

## Installation

Node.js and NPM are required. You must install node version 0.12 prior to running the install command:

```bash
$ npm install -g ballad
```

### build command

```bash
$ ballad build path/to/specs path/to/output.md
```

Loads `spec.json` at the root of `path/to/specs`, and generates a blueprint version of the spec.

### docs command

```bash
$ ballad docs path/to/specs path/to/output.html
```
<commit_msg>updated from build to built<commit_after># Ballad

Assemble API Blueprint specifications with concatenation, templating, and inheritance.

Ballad is designed to write API documentation quickly and easily, using composition and 
keeping things [DRY](https://en.wikipedia.org/wiki/Don%27t_repeat_yourself).

Each component of your specifications should be written with the [API Blueprint](https://apiblueprint.org/) 
format. [Check out how to write Blueprints here](https://docs.apiary.io/api_101/api_blueprint_tutorial/).

Ballad was built with the [spoke-hub distribution paradigm](https://en.wikipedia.org/wiki/Spoke%E2%80%93hub_distribution_paradigm) 
in mind, meaning it easily allows the creation of API specifications derived from a base one, in an object-oriented manner.

# Table of Contents
  1. [Installation](#installation)
  2. [Setting Up a Spec](#setting-up-a-spec)
  3. [JSON Helpers](#json-helpers)
  4. [Usage Examples](#usage-examples)

## Installation

Node.js and NPM are required. You must install node version 0.12 prior to running the install command:

```bash
$ npm install -g ballad
```

### build command

```bash
$ ballad build path/to/specs path/to/output.md
```

Loads `spec.json` at the root of `path/to/specs`, and generates a blueprint version of the spec.

### docs command

```bash
$ ballad docs path/to/specs path/to/output.html
```

{'fraction_non_alphanumeric': 0.10735294117647058, 'fraction_numerical': 0.0125, 'mean_word_length': 4.752642706131078, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 8, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '580809', 'n_tokens_mistral': 885, 'n_tokens_neox': 812, 'n_words': 290}