<commit_before>BigText Makes Text Big
============================

Requirements
----------------------------
1. jQuery
1. A block level parent element, with block level children.

Examples
----------------------------

### Normal Usage

    <div id="bigtext">
        <div>BIGTEXT</div>
        <div>Makes Text Big</div>
    </div>
    <script>
    $('#bigtext').bigtext();
    </script>

### Using a List (ordered/unordered)

    <ol id="bigtext">
        <li>BIGTEXT</li>
        <li>Makes Text Big</li>
    </ol>
    <script>
    $('#bigtext').bigtext();
    </script>

### Using other block child elements

    <div id="bigtext">
        <p>BIGTEXT</p>
        <p>Makes Text Big</p>
    </div>
    <script>
    $('#bigtext').bigtext({
        childSelector: '> p'
    });
    </script>

### Exempting/Excluding Lines

    <ol id="bigtext">
        <li>BIGTEXT</li>
        <li class="bigtext-exempt">Makes Text Big</li>
    </ol>
    <script>
    $('#bigtext').bigtext();
    </script>


### Mix and Match Fonts

    <ol id="bigtext">
        <li>
            <span style="font-family: sans-serif">BIG</span>
            <span style="font-family: serif">TEXT</span>
        </li>
        <li>Makes Text Big</li>
    </ol>
    <script>
    $('#bigtext').bigtext();
    </script>

### Using with Custom Font-Face

    <div id="bigtext">
        <div>BIGTEXT</div>
        <div>Makes Text Big</div>
    </div>
    <script src="//ajax.googleapis.com/ajax/libs/webfont/1/webfont.js"></script>
    <script>
    $(function() {
        WebFont.load({
            custom: {
                families: ['LeagueGothicRegular'], // font-family name
                urls : ['css/fonts/league-gothic/stylesheet.css'] // URL to css
            },
            active: function() {
                $('#bigtext').bigtext();
            }
        });
    });
    </script>

### Change the default max font size

    <div id="bigtext">
        <div>BIG</div><!-- the shorter the line, the larger the size required --> 
    </div>
    <script>
    $('#bigtext').bigtext({
        maxfontsize: 60 // default is 48 (in ems)
    });
    </script>

Extra Features
----------------------------
### Re-BigText on Resize (Responsive BigText)

BigText does not implement its own debounced resize event, to reduce duplicate code. However, it does search for existing implementations. For example, [<NAME>'s Throttle/Debounce plugin](https://github.com/cowboy/jquery-throttle-debounce) or [<NAME>'s SmartResize](https://github.com/lrbabe/jquery-smartresize/), in that order.  If no debounced plugin is found, BigText will bind to the native resize event.

Common Problems
----------------------------

### Lines Wrapping Pre-BigText
The starting font-size must be small enough to guarantee that each individual line is not wrapping pre-BigText.  Adjust the amount of text per line, or set the starting font size using the example below.

#### Change the default min (starting) font size

    <div id="bigtext">
        <div>This is a really long line, that may be too long since it might wrap.</div>
    </div>
    <script>
    // Global Configuration Option
    BigText.STARTING_PX_FONT_SIZE = 8; // default is 11 (in px)
    $('#bigtext').bigtext();
    </script>
    
Releases
----------------------------
<commit_msg>Added link to FitText, added link to known issue with Google/TypeKit WebFontLoader<commit_after>BigText Makes Text Big
============================

Requirements
----------------------------
1. jQuery
1. A block level parent element, with block level children.

Examples
----------------------------

### Normal Usage

    <div id="bigtext">
        <div>BIGTEXT</div>
        <div>Makes Text Big</div>
    </div>
    <script>
    $('#bigtext').bigtext();
    </script>

### Using a List (ordered/unordered)

    <ol id="bigtext">
        <li>BIGTEXT</li>
        <li>Makes Text Big</li>
    </ol>
    <script>
    $('#bigtext').bigtext();
    </script>

### Using other block child elements

    <div id="bigtext">
        <p>BIGTEXT</p>
        <p>Makes Text Big</p>
    </div>
    <script>
    $('#bigtext').bigtext({
        childSelector: '> p'
    });
    </script>

### Exempting/Excluding Lines

    <ol id="bigtext">
        <li>BIGTEXT</li>
        <li class="bigtext-exempt">Makes Text Big</li>
    </ol>
    <script>
    $('#bigtext').bigtext();
    </script>


### Mix and Match Fonts

    <ol id="bigtext">
        <li>
            <span style="font-family: sans-serif">BIG</span>
            <span style="font-family: serif">TEXT</span>
        </li>
        <li>Makes Text Big</li>
    </ol>
    <script>
    $('#bigtext').bigtext();
    </script>

### Using with Custom Font-Face

**Warning**: a known issue exists with the [Google/TypeKit font loader in WebKit](https://github.com/typekit/webfontloader/issues/26).

    <div id="bigtext">
        <div>BIGTEXT</div>
        <div>Makes Text Big</div>
    </div>
    <script src="//ajax.googleapis.com/ajax/libs/webfont/1/webfont.js"></script>
    <script>
    $(function() {
        WebFont.load({
            custom: {
                families: ['LeagueGothicRegular'], // font-family name
                urls : ['css/fonts/league-gothic/stylesheet.css'] // URL to css
            },
            active: function() {
                $('#bigtext').bigtext();
            }
        });
    });
    </script>

### Change the default max font size

    <div id="bigtext">
        <div>BIG</div><!-- the shorter the line, the larger the size required --> 
    </div>
    <script>
    $('#bigtext').bigtext({
        maxfontsize: 60 // default is 48 (in ems)
    });
    </script>

### Is your text static and unchanging?

See [Paravel's FitText plugin](http://fittextjs.com/). Curious how the two plugins compare? I've written a full [comparison between FitText and BigText](http://www.zachleat.com/web/fittext-and-bigtext/).

Extra Features
----------------------------
### Re-BigText on Resize (Responsive BigText)

BigText does not implement its own debounced resize event, to reduce duplicate code. However, it does search for existing implementations. For example, [<NAME>'s Throttle/Debounce plugin](https://github.com/cowboy/jquery-throttle-debounce) or [<NAME>'s SmartResize](https://github.com/lrbabe/jquery-smartresize/), in that order.  If no debounced plugin is found, BigText will bind to the native resize event.

Common Problems
----------------------------

### Lines Wrapping Pre-BigText
The starting font-size must be small enough to guarantee that each individual line is not wrapping pre-BigText.  Adjust the amount of text per line, or set the starting font size using the example below.

#### Change the default min (starting) font size

    <div id="bigtext">
        <div>This is a really long line, that may be too long since it might wrap.</div>
    </div>
    <script>
    // Global Configuration Option
    BigText.STARTING_PX_FONT_SIZE = 8; // default is 11 (in px)
    $('#bigtext').bigtext();
    </script>
    
Releases
----------------------------

{'fraction_non_alphanumeric': 0.18795283420940476, 'fraction_numerical': 0.0031254439551072597, 'mean_word_length': 2.2204940530649586, 'pattern_counts': {'":': 0, '<': 141, '<?xml version=': 0, '>': 143, 'https://': 5, 'lorem ipsum': 0, 'www.': 1, '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': '1724159', 'n_tokens_mistral': 2185, 'n_tokens_neox': 2099, 'n_words': 616}