Skip to content

Commit

Permalink
docs: add nav
Browse files Browse the repository at this point in the history
  • Loading branch information
@prtksxna
prtksxna authored and Sanjaya Kumar Saxena committed Mar 13, 2019
1 parent 9894f06 commit 78d87f5
Show file tree
Hide file tree
Showing 24 changed files with 2,745 additions and 530 deletions.
4 changes: 0 additions & 4 deletions .jsdoc.json
View file
Expand Up @@ -8,10 +8,6 @@
"plugins": ["plugins/markdown"],
"docdash": {
"menu":{
"Wink JS":{
"href":"http://winkjs.org",
"target":"_blank"
},
"Github":{
"href":"https://github.com/winkjs/wink-distance",
"target":"_blank"
Expand Down
121 changes: 117 additions & 4 deletions docs/bow-cosine.js.html
View file
Expand Up @@ -17,16 +17,129 @@
</head>
<body>

<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-47082559-2"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());

gtag('config', 'UA-47082559-2');
</script>
<script src="https://use.typekit.net/cwc1qce.js"></script>
<script>try{Typekit.load({ async: true });}catch(e){}</script>

<style media="screen">
body {
font-family: 'ff-tisa-sans-web-pro', serif;
}
.navbar {
border-top: 4px solid #6C307D;
box-sizing: border-box;
height: 64px;
background-color: #222;
position: fixed;
top: 0;
right: 0;
left: 0;
z-index: 1030;
display: flex;
justify-content: space-between;
}

.navbar-header {
font-weight: bold;
font-size: 30px;
}

.navbar-header a img {
height: 24px;
}

.navbar a {
color: #fff;
line-height: 60px;
margin-left: 20px;
}

.navbar-right {
margin: 0;
line-height: 50px;
list-style: none;
}

.navbar-right li {
float: left;
margin-right: 20px;
text-transform: uppercase;
letter-spacing: 1px;
padding-left: 20px;
font-size: 14px;
}

/* Override docdash */
nav {
top: 80px;
}

#main {
margin-top: 30px;
}
</style>

<script type="text/javascript">
window.addEventListener('DOMContentLoaded', function () {
if ( window.location.hash ) {
openMember();
window.setTimeout( function () {
window.scrollTo( 0, (window.pageYOffset || document.documentElement.scrollTop) - 72);
}, 0)
}
});

window.addEventListener( 'hashchange', function (e) {
e.stopPropagation();
openMember();
} );

function openMember() {
var id = window.location.hash.substr(1),
toggler = document.getElementById( id ),
offset = toggler.getBoundingClientRect().top,
y = window.scrollY + offset - 62 - 10;
window.scrollTo(0, y);
}
</script>

<header>
<div class="navbar">
<div class="navbar-header">
<a href="https://winkjs.org/" title="wink" class="navbar-brand">
<img src="https://winkjs.org/images/logo.svg">
wink
</a>
</div>
<ul class="nav navbar-nav navbar-right collapse navbar-collapse" id="main-nav">
<li><a href="https://winkjs.org/packages.html" class="">Packages</a></li>
<li><a href="https://winkjs.org/blog.html" class="">Blog</a></li>
<li><a href="http://github.com/winkjs">Github</a></li>
<li><a href="https://twitter.com/winkjs_org">Twitter</a></li>
<li><a href="https://winkjs.org/about.html" class="">About</a></li>
</ul>
</div>
</header>


<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
<div class="navicon"></div>
</label>

<label for="nav-trigger" class="overlay"></label>

<nav>
<nav >

<h2><a href="index.html">Home</a></h2><h2><a href="http://winkjs.org" target="_blank" >Wink JS</a></h2><h2><a href="https://github.com/winkjs/wink-distance" target="_blank" >Github</a></h2><h3>Namespaces</h3><ul><li><a href="bow.html">bow</a><ul class='methods'><li data-type='method'><a href="bow.html#.cosine">cosine</a></li></ul></li><li><a href="number.html">number</a><ul class='methods'><li data-type='method'><a href="number.html#.hamming">hamming</a></li></ul></li><li><a href="set.html">set</a><ul class='methods'><li data-type='method'><a href="set.html#.jaccard">jaccard</a></li><li data-type='method'><a href="set.html#.tversky">tversky</a></li></ul></li><li><a href="string.html">string</a><ul class='methods'><li data-type='method'><a href="string.html#.hamming">hamming</a></li><li data-type='method'><a href="string.html#.hammingNormalized">hammingNormalized</a></li><li data-type='method'><a href="string.html#.jaro">jaro</a></li><li data-type='method'><a href="string.html#.jaroWinkler">jaroWinkler</a></li><li data-type='method'><a href="string.html#.levenshtein">levenshtein</a></li><li data-type='method'><a href="string.html#.soundex">soundex</a></li></ul></li><li><a href="vector.html">vector</a><ul class='methods'><li data-type='method'><a href="vector.html#.chebyshev">chebyshev</a></li><li data-type='method'><a href="vector.html#.taxicab">taxicab</a></li></ul></li></ul>
<h2><a href="index.html">Summary</a></h2><h2><a href="https://github.com/winkjs/wink-distance" target="_blank" >Github</a></h2><h3>Namespaces</h3><ul><li><a href="bow.html">bow</a><ul class='methods'><li data-type='method'><a href="bow.html#.cosine">cosine</a></li></ul></li><li><a href="number.html">number</a><ul class='methods'><li data-type='method'><a href="number.html#.hamming">hamming</a></li></ul></li><li><a href="set.html">set</a><ul class='methods'><li data-type='method'><a href="set.html#.jaccard">jaccard</a></li><li data-type='method'><a href="set.html#.tversky">tversky</a></li></ul></li><li><a href="string.html">string</a><ul class='methods'><li data-type='method'><a href="string.html#.hamming">hamming</a></li><li data-type='method'><a href="string.html#.hammingNormalized">hammingNormalized</a></li><li data-type='method'><a href="string.html#.jaro">jaro</a></li><li data-type='method'><a href="string.html#.jaroWinkler">jaroWinkler</a></li><li data-type='method'><a href="string.html#.levenshtein">levenshtein</a></li><li data-type='method'><a href="string.html#.soundex">soundex</a></li></ul></li><li><a href="vector.html">vector</a><ul class='methods'><li data-type='method'><a href="vector.html#.chebyshev">chebyshev</a></li><li data-type='method'><a href="vector.html#.taxicab">taxicab</a></li></ul></li></ul>
</nav>

<div id="main">
Expand Down Expand Up @@ -151,14 +264,14 @@ <h1 class="page-title">bow-cosine.js</h1>





</div>

<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Nov 03 2018 17:23:17 GMT+0530 (IST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Mar 13 2019 10:01:33 GMT+0530 (IST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>

<script>prettyPrint();</script>
Expand Down
126 changes: 122 additions & 4 deletions docs/bow.html
View file
Expand Up @@ -17,16 +17,129 @@
</head>
<body>

<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-47082559-2"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());

gtag('config', 'UA-47082559-2');
</script>
<script src="https://use.typekit.net/cwc1qce.js"></script>
<script>try{Typekit.load({ async: true });}catch(e){}</script>

<style media="screen">
body {
font-family: 'ff-tisa-sans-web-pro', serif;
}
.navbar {
border-top: 4px solid #6C307D;
box-sizing: border-box;
height: 64px;
background-color: #222;
position: fixed;
top: 0;
right: 0;
left: 0;
z-index: 1030;
display: flex;
justify-content: space-between;
}

.navbar-header {
font-weight: bold;
font-size: 30px;
}

.navbar-header a img {
height: 24px;
}

.navbar a {
color: #fff;
line-height: 60px;
margin-left: 20px;
}

.navbar-right {
margin: 0;
line-height: 50px;
list-style: none;
}

.navbar-right li {
float: left;
margin-right: 20px;
text-transform: uppercase;
letter-spacing: 1px;
padding-left: 20px;
font-size: 14px;
}

/* Override docdash */
nav {
top: 80px;
}

#main {
margin-top: 30px;
}
</style>

<script type="text/javascript">
window.addEventListener('DOMContentLoaded', function () {
if ( window.location.hash ) {
openMember();
window.setTimeout( function () {
window.scrollTo( 0, (window.pageYOffset || document.documentElement.scrollTop) - 72);
}, 0)
}
});

window.addEventListener( 'hashchange', function (e) {
e.stopPropagation();
openMember();
} );

function openMember() {
var id = window.location.hash.substr(1),
toggler = document.getElementById( id ),
offset = toggler.getBoundingClientRect().top,
y = window.scrollY + offset - 62 - 10;
window.scrollTo(0, y);
}
</script>

<header>
<div class="navbar">
<div class="navbar-header">
<a href="https://winkjs.org/" title="wink" class="navbar-brand">
<img src="https://winkjs.org/images/logo.svg">
wink
</a>
</div>
<ul class="nav navbar-nav navbar-right collapse navbar-collapse" id="main-nav">
<li><a href="https://winkjs.org/packages.html" class="">Packages</a></li>
<li><a href="https://winkjs.org/blog.html" class="">Blog</a></li>
<li><a href="http://github.com/winkjs">Github</a></li>
<li><a href="https://twitter.com/winkjs_org">Twitter</a></li>
<li><a href="https://winkjs.org/about.html" class="">About</a></li>
</ul>
</div>
</header>


<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
<div class="navicon"></div>
</label>

<label for="nav-trigger" class="overlay"></label>

<nav>
<nav >

<h2><a href="index.html">Home</a></h2><h2><a href="http://winkjs.org" target="_blank" >Wink JS</a></h2><h2><a href="https://github.com/winkjs/wink-distance" target="_blank" >Github</a></h2><h3>Namespaces</h3><ul><li><a href="bow.html">bow</a><ul class='methods'><li data-type='method'><a href="bow.html#.cosine">cosine</a></li></ul></li><li><a href="number.html">number</a><ul class='methods'><li data-type='method'><a href="number.html#.hamming">hamming</a></li></ul></li><li><a href="set.html">set</a><ul class='methods'><li data-type='method'><a href="set.html#.jaccard">jaccard</a></li><li data-type='method'><a href="set.html#.tversky">tversky</a></li></ul></li><li><a href="string.html">string</a><ul class='methods'><li data-type='method'><a href="string.html#.hamming">hamming</a></li><li data-type='method'><a href="string.html#.hammingNormalized">hammingNormalized</a></li><li data-type='method'><a href="string.html#.jaro">jaro</a></li><li data-type='method'><a href="string.html#.jaroWinkler">jaroWinkler</a></li><li data-type='method'><a href="string.html#.levenshtein">levenshtein</a></li><li data-type='method'><a href="string.html#.soundex">soundex</a></li></ul></li><li><a href="vector.html">vector</a><ul class='methods'><li data-type='method'><a href="vector.html#.chebyshev">chebyshev</a></li><li data-type='method'><a href="vector.html#.taxicab">taxicab</a></li></ul></li></ul>
<h2><a href="index.html">Summary</a></h2><h2><a href="https://github.com/winkjs/wink-distance" target="_blank" >Github</a></h2><h3>Namespaces</h3><ul><li><a href="bow.html">bow</a><ul class='methods'><li data-type='method'><a href="bow.html#.cosine">cosine</a></li></ul></li><li><a href="number.html">number</a><ul class='methods'><li data-type='method'><a href="number.html#.hamming">hamming</a></li></ul></li><li><a href="set.html">set</a><ul class='methods'><li data-type='method'><a href="set.html#.jaccard">jaccard</a></li><li data-type='method'><a href="set.html#.tversky">tversky</a></li></ul></li><li><a href="string.html">string</a><ul class='methods'><li data-type='method'><a href="string.html#.hamming">hamming</a></li><li data-type='method'><a href="string.html#.hammingNormalized">hammingNormalized</a></li><li data-type='method'><a href="string.html#.jaro">jaro</a></li><li data-type='method'><a href="string.html#.jaroWinkler">jaroWinkler</a></li><li data-type='method'><a href="string.html#.levenshtein">levenshtein</a></li><li data-type='method'><a href="string.html#.soundex">soundex</a></li></ul></li><li><a href="vector.html">vector</a><ul class='methods'><li data-type='method'><a href="vector.html#.chebyshev">chebyshev</a></li><li data-type='method'><a href="vector.html#.taxicab">taxicab</a></li></ul></li></ul>
</nav>

<div id="main">
Expand Down Expand Up @@ -113,6 +226,8 @@ <h2>








Expand Down Expand Up @@ -291,6 +406,8 @@ <h5>Parameters:</h5>





<h5>Returns:</h5>


Expand All @@ -315,6 +432,7 @@ <h5>Returns:</h5>







Expand All @@ -328,14 +446,14 @@ <h5>Returns:</h5>





</div>

<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Nov 03 2018 17:23:17 GMT+0530 (IST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Mar 13 2019 10:01:33 GMT+0530 (IST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>

<script>prettyPrint();</script>
Expand Down

0 comments on commit 78d87f5

Please sign in to comment.