<commit_before>#stickyNavbar.js
*Just-add-water CSS animation*

stickyNavbar.js: Fancy sticky navigation jQuery plugin with smart anchor links highlighting

##1. Setup
Include reference to jQuery library, jQuery easing plugin (optional), animate.CSS (optional, not working in < IE9) and stickyNavbar itself at the bottom of the page before the closing `body` tag:

```html
<!-- this goes inside the header tag-->
<link href="//cdnjs.cloudflare.com/ajax/libs/animate.css/3.0.0/animate.min.css" rel="stylesheet" type="text/css">
<!-- all these references goes before the closing body tag-->
<script src="http://code.jquery.com/jquery-1.10.2.min.js"></script>
<script src="http://cdnjs.cloudflare.com/ajax/libs/jquery-easing/1.3/jquery.easing.min.js"></script>
<script src="js/jquery.stickyNavbar.min.js"></script>
```

##2. HTML Markup

Navigation:
```html
<div id="header">
   <nav id="nav">
       <ul class="nav navbar-nav">
           <li>
             <a href="#home">Home</a>
           </li>
           <li>
             <a href="#about">About</a>
           </li>
           <li>
             <a href="#services">Services</a>
           </li>
           <li>
             <a href="#contact">Contact</a>
           </li>
       </ul>
   </nav>
</div>
```

Body markup:
```html
<div id="home" class="scrollto">
    <!-- Your content goes here -->
</div>
<div id="about" class="scrollto">
    <!-- Your content goes here -->
</div>
<div id="services" class="scrollto">
    <!-- Your content goes here -->
</div>
<div id="contact" class="scrollto">
    <!-- Your content goes here -->
</div>
```

##3. CSS:
Add `active` class into your `style.css` and style it as you like, eg.:
```css
.active {
    color: #fff !important;
    text-decoration: underline !important;
    -webkit-transform: translate3d(0, 0, 0);
    -moz-transform: translate3d(0, 0, 0);
    -o-transform: translate3d(0, 0, 0);
    -ms-transform: translate3d(0, 0, 0);
    transform: translate3d(0, 0, 0); // hardware acceleration of CSS animation
}
```
*Note: You can change `active` class to anything you want and pass your own class into options object of stickyNavbar function *

##4. jQuery:
Add `active` class into your `style.css` and style it as you like, eg.:
```javascript
$(function () {
   $('.header').stickyNavbar();
});
```

or with the options object:
```javascript
$(function () {
  $('.header').stickyNavbar({
      activeClass: "active",       // Class to be added to highlight nav elements
      sectionSelector: "scrollto", // Class of the section that is interconnected with nav links
      navOffset: 0,                // Offset from the default position of this() (nav container)
      animDuration: 250,           // Duration of jQuery animation
      startAt: 0,                  // Stick the menu at XXXpx from the top of the this() (nav container)
      easing: "linear",            // Easing type if jqueryEffects = true, use jQuery Easing plugin to extend easing types - gsgd.co.uk/sandbox/jquery/easing
      animateCSS: true,           // AnimateCSS effect on/off
      animateCSSRepeat: false,      // Repeat animation everytime user scrolls
      bottomAnimation: false,      // CSS animation on/off in case we hit the bottom of the page
      cssAnimation: "fadeInDown",      // AnimateCSS class that will be added to selector
      jqueryEffects: false,        // jQuery animation on/off
      jqueryAnim: "slideDown",     // jQuery animation type: fadeIn, show or slideDown
      selector: "a",                // Selector to which activeClass will be added, either "a" or "li"
      mobile: false // If false nav will not stick under 496px width of window
  });
});
```

##5. Demo
http://www.jozefbutko.com/stickyNavbar/ or if you want to play with options: http://jsbin.com/wuluj/2/edit
<commit_msg>Readme update<commit_after>#stickyNavbar.js
*Just-add-water CSS animation*

stickyNavbar.js: Fancy sticky navigation jQuery plugin with smart anchor links highlighting

##1. Setup
Include reference to jQuery library, jQuery easing plugin (optional), animate.CSS (optional, not working in < IE9) and stickyNavbar itself at the bottom of the page before the closing `body` tag:

```html
<!-- this goes inside the header tag-->
<link href="//cdnjs.cloudflare.com/ajax/libs/animate.css/3.0.0/animate.min.css" rel="stylesheet" type="text/css">
<!-- all these references goes before the closing body tag-->
<script src="http://code.jquery.com/jquery-1.10.2.min.js"></script>
<script src="http://cdnjs.cloudflare.com/ajax/libs/jquery-easing/1.3/jquery.easing.min.js"></script>
<script src="js/jquery.stickyNavbar.min.js"></script>
```

##2. HTML Markup

Navigation:
```html
<div id="header">
   <nav id="nav">
       <ul class="nav navbar-nav">
           <li>
             <a href="#home">Home</a>
           </li>
           <li>
             <a href="#about">About</a>
           </li>
           <li>
             <a href="#services">Services</a>
           </li>
           <li>
             <a href="#contact">Contact</a>
           </li>
       </ul>
   </nav>
</div>
```

Body markup:
```html
<div id="home" class="scrollto">
    <!-- Your content goes here -->
</div>
<div id="about" class="scrollto">
    <!-- Your content goes here -->
</div>
<div id="services" class="scrollto">
    <!-- Your content goes here -->
</div>
<div id="contact" class="scrollto">
    <!-- Your content goes here -->
</div>
```

##3. CSS:
Add `active` class into your `style.css` and style it as you like, eg.:
```css
.active {
    color: #fff !important;
    text-decoration: underline !important;
    -webkit-transform: translate3d(0, 0, 0);
    -moz-transform: translate3d(0, 0, 0);
    -o-transform: translate3d(0, 0, 0);
    -ms-transform: translate3d(0, 0, 0);
    transform: translate3d(0, 0, 0); // hardware acceleration of CSS animation
}
```
*Note: You can change `active` class to anything you want and pass your own class into options object of stickyNavbar function *

##4. jQuery:
Call stickyNavbar function on the navigation wrapper (`.header`), nav tag or ul tag either without options object:
```javascript
$(function () {
   $('.header').stickyNavbar();
});
```

or with the options object:
```javascript
$(function () {
  $('.header').stickyNavbar({
      activeClass: "active",       	// Class to be added to highlight nav elements
      sectionSelector: "scrollto", 	// Class of the section that is interconnected with nav links
      navOffset: 0,                	// Offset from the default position of this() (nav container)
      animDuration: 250,           	// Duration of jQuery animation
      startAt: 0,                  	// Stick the menu at XXXpx from the top of the this() (nav container)
      easing: "linear",            	// Easing type if jqueryEffects = true, use jQuery Easing plugin to extend easing types - gsgd.co.uk/sandbox/jquery/easing
      animateCSS: true,           	// AnimateCSS effect on/off
      animateCSSRepeat: false,      // Repeat animation everytime user scrolls
      bottomAnimation: false,      	// CSS animation on/off in case we hit the bottom of the page
      cssAnimation: "fadeInDown",      // AnimateCSS class that will be added to selector
      jqueryEffects: false,        	// jQuery animation on/off
      jqueryAnim: "slideDown",     	// jQuery animation type: fadeIn, show or slideDown
      selector: "a",                // Selector to which activeClass will be added, either "a" or "li"
      mobile: false 				// If false nav will not stick under 480px width of window
  });
});
```

##5. Demo
http://www.jozefbutko.com/stickyNavbar/ or if you want to play with options: http://jsbin.com/wuluj/2/edit

{'fraction_non_alphanumeric': 0.14177644450241295, 'fraction_numerical': 0.011477761836441894, 'mean_word_length': 2.7423133235724744, 'pattern_counts': {'":': 0, '<': 91, '<?xml version=': 0, '>': 89, 'https://': 0, 'lorem ipsum': 0, 'www.': 2, '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': '3154823', 'n_tokens_mistral': 2390, 'n_tokens_neox': 2261, 'n_words': 787}