<commit_before>protee
======

A javascript library for fast prototyping<commit_msg>Documentation & design update<commit_after>Protee
======

**Protee** is under early-stage development.

**Protee** is a designer-friendly javascript library for fast prototyping. It is helpful when you want to build an interactive prototype. 

Protee covers common prototyping needs like repeating DOM several times, including another HTML file. It does not need any JavaScript programming experience, which is good for designers who know HTML/CSS but struggle with JS :)

### Dependencies

- jQuery (>=1.9)

### Installation

```
bower install protee --save
```

Make sure to include protee after jQuery.

```html
<script src="path/to/jquery.js"></script>
<script src="path/to/protee.js"></script>
```

### Usage

##### Repeating DOM

Use `data-protee-repeat` HTML attribute to repeat certain DOM for several times.

```html
<div class="container" data-protee-repeat="2">
  <h1 data-protee-repeat="3">Hello</h1>
</div>
```

Generated html will be

```html
<div class="container">
  <h1>Hello</h1>
  <h1>Hello</h1>
  <h1>Hello</h1>
</div>
<div class="container">
  <h1>Hello</h1>
  <h1>Hello</h1>
  <h1>Hello</h1>
</div>
```

##### Include external html

Sometimes it is helpful to include external html, like page header or page footer. `data-protee-include` allows you to include external html.

```html
<!-- /host.html -->
<div data-protee-include="include.html"></div>

<!-- /include.html -->
<h1>Hello</h1>
```

Generated html will be

```html
<!-- /host.html -->
<div>
  <h1>Hello</h1>
</div>
```

Specifing `data-protee-include-replace` will replace the container DOM.

```html
<!-- /host.html -->
<div data-protee-include="include.html"></div>

<!-- /include.html -->
<h1>Hello</h1>
```

Generated html will be

```html
<!-- /host.html -->
<h1>Hello</h1>
```


### Browser Support

Hey! Remember, you are prototyping! So just use cutting-edge modern browsers! :)
{'fraction_non_alphanumeric': 0.1710189452124936, 'fraction_numerical': 0.013312852022529442, 'mean_word_length': 4.238605898123325, 'pattern_counts': {'":': 0, '<': 47, '<?xml version=': 0, '>': 48, 'https://': 0, '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': '1710334', 'n_tokens_mistral': 672, 'n_tokens_neox': 629, 'n_words': 198}