-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
75 lines (75 loc) · 3.29 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Stacky.js</title>
<link rel="stylesheet" href="./src/style.css">
</head>
<body>
<main>
<nav id="stackyHolder">
<section>
<header><h4>Stacky.js</h4></header>
<article>
<small class="arrow">Scroll</small>
<h1>Stacky.js</h1>
</article>
</section>
<section>
<header><h4>About</h4></header>
<article>
<p>Stacky.js is a simple JavaScript module for creating beautiful scrolling navigation lists with stacking headers.</p>
<p>It is a modern alternative to <a title="Slinky.js" href="https://github.com/iclanzan/slinky">Slinky.js</a> without jQuery or any other dependency.</p>
<p>Scroll this page to see it in action!</p>
</article>
</section>
<section>
<header><h4>Features</h4></header>
<article>
<ul>
<li><strong>Vanilla JS</strong> without any dependencies</li>
<li><strong>Lightweight</strong> at around 1KB minified</li>
<li><strong>Refreshes</strong> on window resize and DOM mutation</li>
<li><strong>Compatible</strong> with the latest version of your favorite browser</li>
</ul>
</article>
</section>
<section>
<header><h4>Installation</h4></header>
<article>
<h5>NPM</h5>
<p>Install with npm <code>npm install stacky.js</code> and import in your JS file</p>
<h5>Browser</h5>
<p>Download the files and include in your HTML file <code><script src="path/to/stacky.min.js"></script></code></p>
<p>Check out the <a href="https://github.com/matronator/stacky.js#getting-started" title="How to use Stacky.js">Getting Started</a> section of the README for example code.</p>
</article>
</section>
<section>
<header><h4>Download for use in browser</h4></header>
<article>
<p>Get the latest version for:</p>
<p><a class="btn" title="Unminified version" href="https://raw.githubusercontent.com/matronator/stacky.js/master/dist/stacky.js">Development</a>
<a class="btn" title="Minified version" href="https://raw.githubusercontent.com/matronator/stacky.js/master/dist/stacky.min.js">Production</a></p>
</article>
</section>
<section>
<header><h4>Contributing</h4></header>
<article>
<p>There is always room for improvement in any software and <em>Stacky.js</em> is no different.</p>
<p>The code is hosted on <a href="https://github.com/matronator/stacky.js" title="Stacky.js on GitHub">GitHub</a> and pull requests are more than welcome.</p>
</article>
</section>
<section>
<header><h4>More</h4></header>
<article>
<p>This plugin is brought to you by <a title="Matronator's portfolio" href="https://matronator.com">Matronator</a></p>
<p>Original jQuery plugin Slinky.js and design of this page by <a title="Sorin’s blog" href="http://iclanzan.com">Sorin Iclanzan</a></p>
</article>
</section>
</nav>
</main>
<script src="./dist/stacky.min.js"></script>
<script src="./src/test.js"></script>
</body>
</html>