mirror of
https://github.com/fluencelabs/js-libp2p-utils
synced 2025-04-25 12:02:17 +00:00
chore: update documentation
This commit is contained in:
parent
6cad2632dc
commit
bde733800a
@ -6,7 +6,7 @@
|
|||||||
/* eslint-env amd, node */
|
/* eslint-env amd, node */
|
||||||
|
|
||||||
// https://github.com/umdjs/umd/blob/master/templates/returnExports.js
|
// https://github.com/umdjs/umd/blob/master/templates/returnExports.js
|
||||||
(function(root, factory) {
|
(function (root, factory) {
|
||||||
'use strict';
|
'use strict';
|
||||||
if (typeof define === 'function' && define.amd) {
|
if (typeof define === 'function' && define.amd) {
|
||||||
// AMD. Register as an anonymous module.
|
// AMD. Register as an anonymous module.
|
||||||
@ -21,7 +21,7 @@
|
|||||||
root.AnchorJS = factory();
|
root.AnchorJS = factory();
|
||||||
root.anchors = new root.AnchorJS();
|
root.anchors = new root.AnchorJS();
|
||||||
}
|
}
|
||||||
})(this, function() {
|
})(this, function () {
|
||||||
'use strict';
|
'use strict';
|
||||||
function AnchorJS(options) {
|
function AnchorJS(options) {
|
||||||
this.options = options || {};
|
this.options = options || {};
|
||||||
@ -51,7 +51,7 @@
|
|||||||
* https://github.com/Modernizr/Modernizr/blob/da22eb27631fc4957f67607fe6042e85c0a84656/feature-detects/touchevents.js#L40
|
* https://github.com/Modernizr/Modernizr/blob/da22eb27631fc4957f67607fe6042e85c0a84656/feature-detects/touchevents.js#L40
|
||||||
* @returns {Boolean} - true if the current device supports touch.
|
* @returns {Boolean} - true if the current device supports touch.
|
||||||
*/
|
*/
|
||||||
this.isTouchDevice = function() {
|
this.isTouchDevice = function () {
|
||||||
return !!(
|
return !!(
|
||||||
'ontouchstart' in window ||
|
'ontouchstart' in window ||
|
||||||
(window.DocumentTouch && document instanceof DocumentTouch)
|
(window.DocumentTouch && document instanceof DocumentTouch)
|
||||||
@ -64,7 +64,7 @@
|
|||||||
* to. Also accepts an array or nodeList containing the relavant elements.
|
* to. Also accepts an array or nodeList containing the relavant elements.
|
||||||
* @returns {this} - The AnchorJS object
|
* @returns {this} - The AnchorJS object
|
||||||
*/
|
*/
|
||||||
this.add = function(selector) {
|
this.add = function (selector) {
|
||||||
var elements,
|
var elements,
|
||||||
elsWithIds,
|
elsWithIds,
|
||||||
idList,
|
idList,
|
||||||
@ -193,7 +193,7 @@
|
|||||||
* OR a nodeList / array containing the DOM elements.
|
* OR a nodeList / array containing the DOM elements.
|
||||||
* @returns {this} - The AnchorJS object
|
* @returns {this} - The AnchorJS object
|
||||||
*/
|
*/
|
||||||
this.remove = function(selector) {
|
this.remove = function (selector) {
|
||||||
var index,
|
var index,
|
||||||
domAnchor,
|
domAnchor,
|
||||||
elements = _getElements(selector);
|
elements = _getElements(selector);
|
||||||
@ -216,7 +216,7 @@
|
|||||||
/**
|
/**
|
||||||
* Removes all anchorjs links. Mostly used for tests.
|
* Removes all anchorjs links. Mostly used for tests.
|
||||||
*/
|
*/
|
||||||
this.removeAll = function() {
|
this.removeAll = function () {
|
||||||
this.remove(this.elements);
|
this.remove(this.elements);
|
||||||
};
|
};
|
||||||
|
|
||||||
@ -229,7 +229,7 @@
|
|||||||
* @param {String} text - Any text. Usually pulled from the webpage element we are linking to.
|
* @param {String} text - Any text. Usually pulled from the webpage element we are linking to.
|
||||||
* @returns {String} - hyphen-delimited text for use in IDs and URLs.
|
* @returns {String} - hyphen-delimited text for use in IDs and URLs.
|
||||||
*/
|
*/
|
||||||
this.urlify = function(text) {
|
this.urlify = function (text) {
|
||||||
// Regex for finding the nonsafe URL characters (many need escaping): & +$,:;=?@"#{}|^~[`%!'<>]./()*\
|
// Regex for finding the nonsafe URL characters (many need escaping): & +$,:;=?@"#{}|^~[`%!'<>]./()*\
|
||||||
var nonsafeChars = /[& +$,:;=?@"#{}|^~[`%!'<>\]\.\/\(\)\*\\]/g,
|
var nonsafeChars = /[& +$,:;=?@"#{}|^~[`%!'<>\]\.\/\(\)\*\\]/g,
|
||||||
urlText;
|
urlText;
|
||||||
@ -260,7 +260,7 @@
|
|||||||
* @param {HTMLElemnt} el - a DOM node
|
* @param {HTMLElemnt} el - a DOM node
|
||||||
* @returns {Boolean} true/false
|
* @returns {Boolean} true/false
|
||||||
*/
|
*/
|
||||||
this.hasAnchorJSLink = function(el) {
|
this.hasAnchorJSLink = function (el) {
|
||||||
var hasLeftAnchor =
|
var hasLeftAnchor =
|
||||||
el.firstChild &&
|
el.firstChild &&
|
||||||
(' ' + el.firstChild.className + ' ').indexOf(' anchorjs-link ') > -1,
|
(' ' + el.firstChild.className + ' ').indexOf(' anchorjs-link ') > -1,
|
||||||
|
@ -7,7 +7,7 @@ anchors.add('h3');
|
|||||||
// Filter UI
|
// Filter UI
|
||||||
var tocElements = document.getElementById('toc').getElementsByTagName('li');
|
var tocElements = document.getElementById('toc').getElementsByTagName('li');
|
||||||
|
|
||||||
document.getElementById('filter-input').addEventListener('keyup', function(e) {
|
document.getElementById('filter-input').addEventListener('keyup', function (e) {
|
||||||
var i, element, children;
|
var i, element, children;
|
||||||
|
|
||||||
// enter key
|
// enter key
|
||||||
@ -22,14 +22,14 @@ document.getElementById('filter-input').addEventListener('keyup', function(e) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
var match = function() {
|
var match = function () {
|
||||||
return true;
|
return true;
|
||||||
};
|
};
|
||||||
|
|
||||||
var value = this.value.toLowerCase();
|
var value = this.value.toLowerCase();
|
||||||
|
|
||||||
if (!value.match(/^\s*$/)) {
|
if (!value.match(/^\s*$/)) {
|
||||||
match = function(element) {
|
match = function (element) {
|
||||||
var html = element.firstChild.innerHTML;
|
var html = element.firstChild.innerHTML;
|
||||||
return html && html.toLowerCase().indexOf(value) !== -1;
|
return html && html.toLowerCase().indexOf(value) !== -1;
|
||||||
};
|
};
|
||||||
@ -114,12 +114,12 @@ var cw_without_sb = split_left.clientWidth;
|
|||||||
split_left.style.overflow = '';
|
split_left.style.overflow = '';
|
||||||
|
|
||||||
Split(['#split-left', '#split-right'], {
|
Split(['#split-left', '#split-right'], {
|
||||||
elementStyle: function(dimension, size, gutterSize) {
|
elementStyle: function (dimension, size, gutterSize) {
|
||||||
return {
|
return {
|
||||||
'flex-basis': 'calc(' + size + '% - ' + gutterSize + 'px)'
|
'flex-basis': 'calc(' + size + '% - ' + gutterSize + 'px)'
|
||||||
};
|
};
|
||||||
},
|
},
|
||||||
gutterStyle: function(dimension, gutterSize) {
|
gutterStyle: function (dimension, gutterSize) {
|
||||||
return {
|
return {
|
||||||
'flex-basis': gutterSize + 'px'
|
'flex-basis': gutterSize + 'px'
|
||||||
};
|
};
|
||||||
@ -152,9 +152,9 @@ function loadState(ev) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
window.addEventListener('load', function() {
|
window.addEventListener('load', function () {
|
||||||
// Restore after Firefox scrolls to hash.
|
// Restore after Firefox scrolls to hash.
|
||||||
setTimeout(function() {
|
setTimeout(function () {
|
||||||
loadState();
|
loadState();
|
||||||
// Update with initial scroll position.
|
// Update with initial scroll position.
|
||||||
updateState();
|
updateState();
|
||||||
|
45
index.html
45
index.html
@ -2,7 +2,7 @@
|
|||||||
<html lang="en">
|
<html lang="en">
|
||||||
<head>
|
<head>
|
||||||
<meta charset='utf-8'>
|
<meta charset='utf-8'>
|
||||||
<title>libp2p-utils 0.1.2 | Documentation</title>
|
<title>libp2p-utils 0.1.3 | Documentation</title>
|
||||||
<meta name='description' content='Package to aggregate shared logic and dependencies for the libp2p ecosystem'>
|
<meta name='description' content='Package to aggregate shared logic and dependencies for the libp2p ecosystem'>
|
||||||
<meta name='viewport' content='width=device-width,initial-scale=1'>
|
<meta name='viewport' content='width=device-width,initial-scale=1'>
|
||||||
<link href='assets/bass.css' rel='stylesheet'>
|
<link href='assets/bass.css' rel='stylesheet'>
|
||||||
@ -15,25 +15,18 @@
|
|||||||
<div id='split-left' class='overflow-auto fs0 height-viewport-100'>
|
<div id='split-left' class='overflow-auto fs0 height-viewport-100'>
|
||||||
<div class='py1 px2'>
|
<div class='py1 px2'>
|
||||||
<h3 class='mb0 no-anchor'>libp2p-utils</h3>
|
<h3 class='mb0 no-anchor'>libp2p-utils</h3>
|
||||||
<div class='mb1'><code>0.1.2</code></div>
|
<div class='mb1'><code>0.1.3</code></div>
|
||||||
<input
|
<input
|
||||||
placeholder='Filter'
|
placeholder='Filter'
|
||||||
id='filter-input'
|
id='filter-input'
|
||||||
class='col12 block input'
|
class='col12 block input'
|
||||||
|
spellcheck='false'
|
||||||
|
autocapitalize='off'
|
||||||
|
autocorrect='off'
|
||||||
type='text' />
|
type='text' />
|
||||||
<div id='toc'>
|
<div id='toc'>
|
||||||
<ul class='list-reset h5 py1-ul'>
|
<ul class='list-reset h5 py1-ul'>
|
||||||
|
|
||||||
|
|
||||||
<li><a
|
|
||||||
href='#intro'
|
|
||||||
class="h5 bold black caps">
|
|
||||||
Intro
|
|
||||||
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</li>
|
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
<div class='mt1 h6 quiet'>
|
<div class='mt1 h6 quiet'>
|
||||||
@ -43,34 +36,6 @@
|
|||||||
</div>
|
</div>
|
||||||
<div id='split-right' class='relative overflow-auto height-viewport-100'>
|
<div id='split-right' class='relative overflow-auto height-viewport-100'>
|
||||||
|
|
||||||
|
|
||||||
<div class='keyline-top-not py2'><section class='py2 clearfix'>
|
|
||||||
|
|
||||||
<h2 id='intro' class='mt0'>
|
|
||||||
Intro
|
|
||||||
</h2>
|
|
||||||
|
|
||||||
|
|
||||||
<p>Installable via <code>npm install --save libp2p-utils</code>, it can also be used directly in the browser.</p>
|
|
||||||
<h2>Download</h2>
|
|
||||||
<p>The source is available for download from <a href="git+https://github.com/libp2p/js-libp2p-utils.git">GitHub</a>. Alternatively, you can install using npm:</p>
|
|
||||||
<pre class='hljs'>$ npm install --save libp2p-utils</pre>
|
|
||||||
<p>You can then <code>require()</code> libp2p-utils as normal:</p>
|
|
||||||
<pre class='hljs'><span class="hljs-keyword">const</span> libp2PUtils = <span class="hljs-built_in">require</span>(<span class="hljs-string">'libp2p-utils'</span>)</pre>
|
|
||||||
<h2>In the Browser</h2>
|
|
||||||
<p>Libp2p-utils should work in any ES2015 environment out of the box.</p>
|
|
||||||
<p>Usage:</p>
|
|
||||||
<pre class='hljs'><span class="hljs-tag"><<span class="hljs-name">script</span> <span class="hljs-attr">type</span>=<span class="hljs-string">"text/javascript"</span> <span class="hljs-attr">src</span>=<span class="hljs-string">"index.js"</span>></span><span class="hljs-tag"></<span class="hljs-name">script</span>></span></pre>
|
|
||||||
<p>The portable versions of libp2p-utils, including <code>index.js</code> and <code>index.min.js</code>, are included in the <code>/dist</code> folder. Libp2p-utils can also be found on <a href="https://unpkg.com">unpkg.com</a> under</p>
|
|
||||||
<ul>
|
|
||||||
<li><a href="https://unpkg.com/libp2p-utils/dist/index.min.js">https://unpkg.com/libp2p-utils/dist/index.min.js</a></li>
|
|
||||||
<li><a href="https://unpkg.com/libp2p-utils/dist/index.js">https://unpkg.com/libp2p-utils/dist/index.js</a></li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
|
|
||||||
</section></div>
|
|
||||||
|
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<script src='assets/anchor.js'></script>
|
<script src='assets/anchor.js'></script>
|
||||||
|
Loading…
x
Reference in New Issue
Block a user