<commit_before># bootprint-openapi 

[![NPM version](https://img.shields.io/npm/v/bootprint-openapi.svg)](https://npmjs.com/package/bootprint-openapi)
[![Travis Build Status](https://travis-ci.org/bootprint/bootprint-openapi.svg?branch=master)](https://travis-ci.org/bootprint/bootprint-openapi)
[![Coverage Status](https://img.shields.io/coveralls/bootprint/bootprint-openapi.svg)](https://coveralls.io/r/bootprint/bootprint-openapi)

> Converts a openapi-definition into a static html page

## Maintainers / Contributors wanted

I'm still looking for people to help me with the bootprint project. I have found some new ambitions to make 
bootprint-openapi the greatest offline documentation generator for OpenAPI specifications. I have started, by releasing
the current version as 1.0 to show that it's time to start using [semver](https://npmjs.com/package/semver) for versioning.

I have created a Twitter account [@bootprintjs](https://twitter.com/bootprintjs) that will now be used for announcments
and for gathering user feedback. I also plan to setup a blog.

But I might still need your help. I am, for example, certain, that there are greater designers out there than me and I
feel that some parts of bootprint-openapi need a redesign. So: 

* If you want to start maintaining the module(s), please let me know and I'll give you push access.
* I will help you by giving pointers to code-lines that need to be changed for a given feature.
* I will try to publish new versions as fast as possible.
* I might also give you publishing-rights on npm, although that seems like a large step and I would have to 
  be confident that you don't misuse it.

## Overview

This package contains a template, partials and styles for [bootprint](http://npmjs.com/bootprint) to convert
OpenAPI-Specifications into a static HTML-page.

This package was formerly known as `bootprint-swagger` and has been renamed, because 
Swagger-Specification has been renamed to OpenAPI-Specification
## Installation

In order to use `bootprint-openapi` from the command line
you have to install `bootprint` and `bootprint-openapi` globally:

```bash
npm install -g bootprint
npm install -g bootprint-openapi
```

**Check this out:** You can now [try out the new bootprint-openapi playground](http://bootprint.knappmeier.de/).
Just paste a OpenAPI-specification and make it readable. 


## Usage

```
bootprint openapi http://petstore.swagger.io/v2/swagger.json target
```

The directory "target" should now contain a file `index.html` and `main.css` which contain a readable
form of the [Swagger-Petstore-Example](http://petstore.swagger.io/).
<commit_msg>doc: fix link to bootprint playground<commit_after># bootprint-openapi 

[![NPM version](https://img.shields.io/npm/v/bootprint-openapi.svg)](https://npmjs.com/package/bootprint-openapi)
[![Travis Build Status](https://travis-ci.org/bootprint/bootprint-openapi.svg?branch=master)](https://travis-ci.org/bootprint/bootprint-openapi)
[![Coverage Status](https://img.shields.io/coveralls/bootprint/bootprint-openapi.svg)](https://coveralls.io/r/bootprint/bootprint-openapi)

> Converts a openapi-definition into a static html page

## Maintainers / Contributors wanted

I'm still looking for people to help me with the bootprint project. I have found some new ambitions to make 
bootprint-openapi the greatest offline documentation generator for OpenAPI specifications. I have started, by releasing
the current version as 1.0 to show that it's time to start using [semver](https://npmjs.com/package/semver) for versioning.

I have created a Twitter account [@bootprintjs](https://twitter.com/bootprintjs) that will now be used for announcments
and for gathering user feedback. I also plan to setup a blog.

But I might still need your help. I am, for example, certain, that there are greater designers out there than me and I
feel that some parts of bootprint-openapi need a redesign. So: 

* If you want to start maintaining the module(s), please let me know and I'll give you push access.
* I will help you by giving pointers to code-lines that need to be changed for a given feature.
* I will try to publish new versions as fast as possible.
* I might also give you publishing-rights on npm, although that seems like a large step and I would have to 
  be confident that you don't misuse it.

## Overview

This package contains a template, partials and styles for [bootprint](http://npmjs.com/bootprint) to convert
OpenAPI-Specifications into a static HTML-page.

This package was formerly known as `bootprint-swagger` and has been renamed, because 
Swagger-Specification has been renamed to OpenAPI-Specification
## Installation

In order to use `bootprint-openapi` from the command line
you have to install `bootprint` and `bootprint-openapi` globally:

```bash
npm install -g bootprint
npm install -g bootprint-openapi
```

**Check this out:** You can now [try out the new bootprint-openapi playground](https://bootprint.kanppi.org)
Just paste a OpenAPI-specification and make it readable. 


## Usage

```
bootprint openapi http://petstore.swagger.io/v2/swagger.json target
```

The directory "target" should now contain a file `index.html` and `main.css` which contain a readable
form of the [Swagger-Petstore-Example](http://petstore.swagger.io/).

{'fraction_non_alphanumeric': 0.0909606656580938, 'fraction_numerical': 0.0011346444780635401, 'mean_word_length': 4.687096774193549, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 5, 'https://': 17, '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': '5227510', 'n_tokens_mistral': 1567, 'n_tokens_neox': 1479, 'n_words': 625}