| Current File : //home/tradevaly/public_html/public/assets/frontend/OwlCarousel/docs/docs/support-contributing.html |
<!DOCTYPE html>
<html lang="en">
<head>
<!-- head -->
<meta charset="utf-8">
<meta name="msapplication-tap-highlight" content="no" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="description" content="Owl Carousel Documentation">
<meta name="author" content="David Deutsch">
<title>
Contributing | Owl Carousel | 2.3.4
</title>
<!-- Stylesheets -->
<link href='https://fonts.googleapis.com/css?family=Lato:300,400,700,400italic,300italic' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="../assets/css/docs.theme.min.css">
<!-- Owl Stylesheets -->
<link rel="stylesheet" href="../assets/owlcarousel/assets/owl.carousel.min.css">
<link rel="stylesheet" href="../assets/owlcarousel/assets/owl.theme.default.min.css">
<!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
<script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
<![endif]-->
<!-- Favicons -->
<link rel="apple-touch-icon-precomposed" sizes="144x144" href="../assets/ico/apple-touch-icon-144-precomposed.png">
<link rel="shortcut icon" href="../assets/ico/favicon.png">
<link rel="shortcut icon" href="favicon.ico">
<!-- Yeah i know js should not be in header. Its required for demos.-->
<!-- javascript -->
<script src="../assets/vendors/jquery.min.js"></script>
<script src="../assets/owlcarousel/owl.carousel.js"></script>
</head>
<body>
<!-- header -->
<header class="header">
<div class="row">
<div class="large-12 columns">
<div class="brand left">
<h3>
<a href="/OwlCarousel2/">owl.carousel.js</a>
</h3>
</div>
<a id="toggle-nav" class="right">
<span></span> <span></span> <span></span>
</a>
<div class="nav-bar">
<ul class="clearfix">
<li> <a href="/OwlCarousel2/index.html">Home</a> </li>
<li> <a href="/OwlCarousel2/demos/demos.html">Demos</a> </li>
<li class="active">
<a href="/OwlCarousel2/docs/started-welcome.html">Docs</a>
</li>
<li>
<a href="https://github.com/OwlCarousel2/OwlCarousel2/archive/2.3.4.zip">Download</a>
<span class="download"></span>
</li>
</ul>
</div>
</div>
</div>
</header>
<!-- title -->
<section class="title">
<div class="row">
<div class="large-12 columns">
<h1>Support</h1>
</div>
</div>
</section>
<div id="docs">
<div class="row">
<div class="small-12 medium-3 large-3 columns">
<ul class="side-nav">
<li class="side-nav-head">Getting Started</li>
<li> <a href="started-welcome.html">Welcome</a> </li>
<li> <a href="started-installation.html">Installation</a> </li>
<li> <a href="started-faq.html">FAQ</a> </li>
</ul>
<ul class="side-nav">
<li class="side-nav-head">API</li>
<li> <a href="api-options.html">Options</a> </li>
<li> <a href="api-classes.html">Classes</a> </li>
<li> <a href="api-events.html">Events</a> </li>
</ul>
<ul class="side-nav">
<li class="side-nav-head">Development</li>
<li> <a href="dev-buildin-plugins.html">Built-in Plugins</a> </li>
<li> <a href="dev-plugin-api.html">Plugin API</a> </li>
<li> <a href="dev-styles.html">Sass Styles</a> </li>
<li> <a href="dev-external.html">External Libs</a> </li>
</ul>
<ul class="side-nav">
<li class="side-nav-head">Support</li>
<li> <a href="support-contributing.html">Contributing</a> </li>
<li> <a href="support-changelog.html">Changelog</a> </li>
<li> <a href="support-contact.html">Contact</a> </li>
</ul>
</div>
<div class="small-12 medium-9 large-9 columns">
<article class="docs-content">
<h2 id="contributing">Contributing</h2>
<blockquote>
<p>This project is hosted by Smashing Boxes but so many awesome contributors have had a big impact on the code. Thanks to all the amazing people who spent hours helping me with the development and teaching me new tricks!</p>
</blockquote>
<p>If you are looking to support Owl Carousel with your amazing ideas (or just fix some nasty bugs) then go to
<a href="https://github.com/OwlCarousel2/OwlCarousel2">Github</a> and fork the project.</p>
<h3 id="some-tips-for-contributors">Some tips for contributors</h3>
<p>Owl Carousel is built around Grunt, Bower and Assemble frameworks. If you are not familiar with those tools please visit:</p>
<ul>
<li> <a href="https://nodejs.org/">Node.js</a> </li>
<li> <a href="http://yeoman.io/">Yeoman</a> </li>
<li> <a href="http://gruntjs.com/">Grunt</a> </li>
<li> <a href="http://bower.io/">Bower</a> </li>
<li> <a href="http://assemble.io/">Assemble</a> </li>
</ul>
<h3 id="installation-dependecies">Installation dependecies</h3>
<p>Open Terminal, go to folder with project and type:</p>
<pre><code>npm install</code></pre>
<p>Then install bower components</p>
<pre><code>bower install</code></pre>
<h3 id="grunt-tasks">Grunt Tasks</h3>
<p>The default task runs two other tasks: <code>dist</code> and <code>docs</code>. Type grunt to run default:</p>
<pre><code>grunt</code></pre>
<p>Now that the whole project is generated, run the last grunt task:</p>
<pre><code>grunt serve</code></pre>
<p>This creates localhost server and opens docs in your default browser. <code>watch</code> tasks will look for any changes and will automatically update the project and reload the browser.</p>
<p>Now you are ready to make some cool updates by yourself. Owl project is in <code>src</code> folder. Also dont change <code>src/css/*.css</code> - all css files are generated from sass.</p>
<blockquote>
<p>Happy Coding</p>
</blockquote>
</article>
</div>
</div>
</div>
<!-- footer -->
<footer class="footer">
<div class="row">
<div class="large-12 columns">
<h5>
<a href="/OwlCarousel2/docs/support-contact.html">David Deutsch</a>
<a id="custom-tweet-button" href="https://twitter.com/share?url=https://github.com/OwlCarousel2/OwlCarousel2&text=Owl Carousel - This is so awesome! " target="_blank"></a>
</h5>
</div>
</div>
</footer>
<!-- vendors -->
<script src="../assets/vendors/highlight.js"></script>
<script src="../assets/js/app.js"></script>
</body>
</html>