Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@Raynos
Raynos committed Aug 18, 2012
1 parent ca54b11 commit 442dcea
Show file tree
Hide file tree
Showing 15 changed files with 1,338 additions and 9 deletions.
3 changes: 3 additions & 0 deletions Makefile
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Your looking at the docs
docs:
./node_modules/.bin/docker -x node_modules,doc
165 changes: 165 additions & 0 deletions doc/README.md.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,165 @@
<!DOCTYPE html>
<html>
<head>
<title>README.md</title>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<link rel="stylesheet" media="all" href="doc-style.css" />
<script src="doc-filelist.js"></script>
<script>
var relativeDir = '', thisFile = 'README.md', defaultSidebar = true;
</script>
<script src="doc-script.js"></script>
</head>
<body>
<div id="sidebar_wrapper">
<div id="sidebar_switch">
<span class="tree">Files</span>
<span class="headings">Headings</span>
</div>
<div id="tree"></div>
<div id="headings">
<div class="heading h1">
<a href="#stream-chat">stream-chat</a>
</div>
<div class="heading h2">
<a href="#the-interesting-bits">The interesting bits</a>
</div>
<div class="heading h1">
<a href="#the-server-is-a-static-file-server">The server is a static file server</a>
</div>
<div class="heading h1">
<a href="#connections-to-the-discovery-network">Connections to the discovery network</a>
</div>
<div class="heading h1">
<a href="#open-relay-streams-to-a-named-relay-network">Open relay streams to a named relay network</a>
</div>
<div class="heading h1">
<a href="#manipulate-direct-stream-connections-to-peers">Manipulate direct stream connections to peers</a>
</div>
<div class="heading h1">
<a href="#your-ui-component-is-a-stream">Your UI component is a stream</a>
</div>
<div class="heading h1">
<a href="#start-building-distributed-apps-on-the-cloud-today-">Start building distributed apps on the cloud today!</a>
</div>
<div class="heading h2">
<a href="#contributors">Contributors</a>
</div>
<div class="heading h2">
<a href="#mit-licenced">MIT Licenced</a>
</div>
</div>
</div>
<div id="sidebar-toggle"></div>
<div id="container"><div class="docs markdown">
<div class="pilwrap" id="stream-chat">
<h1>
<a href="#stream-chat" class="pilcrow">&#182;</a>
stream-chat
</h1>
</div>


<p>A chat app using streams</p>

<p>Live at: <a href='http://raynos.stream-chat.jit.su/'>http://raynos.stream-chat.jit.su/</a></p>


<div class="pilwrap" id="the-interesting-bits">
<h2>
<a href="#the-interesting-bits" class="pilcrow">&#182;</a>
The interesting bits
</h2>
</div>


<p>Demonstrates usage of using discoverynetwork.co to build distributed apps</p>


<div class="pilwrap" id="the-server-is-a-static-file-server">
<h1>
<a href="#the-server-is-a-static-file-server" class="pilcrow">&#182;</a>
<a href="https://github.com/Raynos/stream-chat/blob/master/index.js#L1">The server is a static file server</a>
</h1>
</div>


<p>Distributed peer to peer apps are served from static file servers and use a discovery network in the cloud to establish peer to peer connections (through a relay server due to browser limitations)</p>


<div class="pilwrap" id="connections-to-the-discovery-network">
<h1>
<a href="#connections-to-the-discovery-network" class="pilcrow">&#182;</a>
<a href="https://github.com/Raynos/stream-chat/blob/master/static/index.js#L7">Connections to the discovery network</a>
</h1>
</div>


<p>Open a connection to a cloud based discovery network. Then simply discover your peers and open connections to them</p>


<div class="pilwrap" id="open-relay-streams-to-a-named-relay-network">
<h1>
<a href="#open-relay-streams-to-a-named-relay-network" class="pilcrow">&#182;</a>
<a href="https://github.com/Raynos/stream-chat/blob/master/static/index.js#L21">Open relay streams to a named relay network</a>
</h1>
</div>


<p>Once you have a connection to the discovery network you can open a fresh named connection to a relay network. Each relay network has a unique name and only contains the peers attached to that unique name.</p>


<div class="pilwrap" id="manipulate-direct-stream-connections-to-peers">
<h1>
<a href="#manipulate-direct-stream-connections-to-peers" class="pilcrow">&#182;</a>
<a href="https://github.com/Raynos/stream-chat/blob/master/static/index.js#L23">Manipulate direct stream connections to peers</a>
</h1>
</div>


<p>When a peer enters the network you get a direct stream connection to him. Now just talk to him!</p>


<div class="pilwrap" id="your-ui-component-is-a-stream">
<h1>
<a href="#your-ui-component-is-a-stream" class="pilcrow">&#182;</a>
<a href="https://github.com/Raynos/stream-chat/blob/master/static/components/room.js#L13">Your UI component is a stream</a>
</h1>
</div>


<p>If your UI component is a stream then you can pipe it directly to another peer. Once you get data from that peer simply render it. If you have data to send to the peer simply emit it.</p>


<div class="pilwrap" id="start-building-distributed-apps-on-the-cloud-today-">
<h1>
<a href="#start-building-distributed-apps-on-the-cloud-today-" class="pilcrow">&#182;</a>
Start building distributed apps on the cloud today!
</h1>
</div>



<div class="pilwrap" id="contributors">
<h2>
<a href="#contributors" class="pilcrow">&#182;</a>
Contributors
</h2>
</div>


<ul>
<li>Raynos</li>
</ul>


<div class="pilwrap" id="mit-licenced">
<h2>
<a href="#mit-licenced" class="pilcrow">&#182;</a>
MIT Licenced
</h2>
</div>
</div>
</div>
</body>
</html>
1 change: 1 addition & 0 deletions doc/doc-filelist.js
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

223 changes: 223 additions & 0 deletions doc/doc-script.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,223 @@
// # res/script.js
//
// This is the script file that gets copied into the output. It mainly manages the display
// of the folder tree. The idea of this script file is to be minimal and standalone. So
// that means no jQuery.

// Use localStorage to store data about the tree's state: whether or not
// the tree is visible and which directories are expanded. Unless the state
var sidebarVisible = (window.localStorage && window.localStorage.docker_showSidebar) ?
window.localStorage.docker_showSidebar == 'yes' :
defaultSidebar;

/**
* ## makeTree
*
* Consructs the folder tree view
*
* @param {object} treeData Folder structure as in [queueFile](../src/docker.js.html#docker.prototype.queuefile)
* @param {string} root Path from current file to root (ie `'../../'` etc.)
* @param {string} filename The current file name
*/
function makeTree(treeData, root, filename){
var treeNode = document.getElementById('tree');
var treeHandle = document.getElementById('sidebar-toggle');
treeHandle.addEventListener('click', toggleTree, false);

// Build the html and add it to the container.
treeNode.innerHTML = nodeHtml('', treeData, '', root);

// Root folder (whole tree) should always be open
treeNode.childNodes[0].className += ' open';

// Attach click event handler
treeNode.addEventListener('click', nodeClicked, false);

if(sidebarVisible) document.body.className += ' sidebar';

// Restore scroll position from localStorage if set. And attach scroll handler
if(window.localStorage && window.localStorage.docker_treeScroll) treeNode.scrollTop = window.localStorage.docker_treeScroll;
treeNode.onscroll = treeScrolled;

// Only set a class to allow CSS transitions after the tree state has been painted
setTimeout(function(){ document.body.className += ' slidey'; }, 100);
}

/**
* ## treeScrolled
*
* Called when the tree is scrolled. Stores the scroll position in localStorage
* so it can be restored on the next pageview.
*/
function treeScrolled(){
var tree = document.getElementById('tree');
if(window.localStorage) window.localStorage.docker_treeScroll = tree.scrollTop;
}

/**
* ## nodeClicked
*
* Called when a directory is clicked. Toggles open state of the directory
*
* @param {Event} e The click event
*/
function nodeClicked(e){

// Find the target
var t = e.target;

// If the click target is actually a file (rather than a directory), ignore it
if(t.tagName.toLowerCase() !== 'div' || t.className === 'children') return;

// Recurse upwards until we find the actual directory node
while(t && t.className.substring(0,3) != 'dir') t = t.parentNode;

// If we're at the root node, then do nothing (we don't allow collapsing of the whole tree)
if(!t || t.parentNode.id == 'tree') return;

// Find the path and toggle the state, saving the state in the localStorage variable
var path = t.getAttribute('rel');
if(t.className.indexOf('open') !== -1){
t.className=t.className.replace(/\s*open/g,'');
if(window.localStorage) window.localStorage.removeItem('docker_openPath:' + path);
}else{
t.className += ' open';
if(window.localStorage) window.localStorage['docker_openPath:' + path] = 'yes';
}
}


/**
* ## nodeHtml
*
* Constructs the markup for a directory in the tree
*
* @param {string} nodename The node name.
* @param {object} node Node object of same format as whole tree.
* @param {string} path The path form the base to this node
* @param {string} root Relative path from current page to root
*/
function nodeHtml(nodename, node, path, root){
// Firstly, figure out whether or not the directory is expanded from localStorage
var isOpen = window.localStorage && window.localStorage['docker_openPath:' + path] == 'yes';
var out = '<div class="dir' + (isOpen ? ' open' : '') + '" rel="' + path + '">';
out += '<div class="nodename">' + nodename + '</div>';
out += '<div class="children">';

// Loop through all child directories first
if(node.dirs){
var dirs = [];
for(var i in node.dirs){
if(node.dirs.hasOwnProperty(i)) dirs.push({ name: i, html: nodeHtml(i, node.dirs[i], path + i + '/', root) });
}
// Have to store them in an array first and then sort them alphabetically here
dirs.sort(function(a, b){ return (a.name > b.name) ? 1 : (a.name == b.name) ? 0 : -1; });

for(var k = 0; k < dirs.length; k += 1) out += dirs[k].html;
}

// Now loop through all the child files alphabetically
if(node.files){
node.files.sort();
for(var j = 0; j < node.files.length; j += 1){
out += '<a class="file" href="' + root + path + node.files[j] + '.html">' + node.files[j] + '</a>';
}
}

// Close things off
out += '</div></div>';

return out;
}

/**
* ## toggleTree
*
* Toggles the visibility of the folder tree
*/
function toggleTree(){
// Do the actual toggling by modifying the class on the body element. That way we can get some nice CSS transitions going.
if(sidebarVisible){
document.body.className = document.body.className.replace(/\s*sidebar/g,'');
sidebarVisible = false;
}else{
document.body.className += ' sidebar';
sidebarVisible = true;
}
if(window.localStorage){
if(sidebarVisible){
window.localStorage.docker_showSidebar = 'yes';
}else{
window.localStorage.docker_showSidebar = 'no';
}
}
}

/**
* ## wireUpTabs
*
* Wires up events on the sidebar tabe
*/
function wireUpTabs(){
var tabEl = document.getElementById('sidebar_switch');
var children = tabEl.childNodes;

// Each tab has a class corresponding of the id of its tab pane
for(var i = 0, l = children.length; i < l; i += 1){
// Ignore text nodes
if(children[i].nodeType !== 1) continue;
children[i].addEventListener('click', function(c){
return function(){ switchTab(c); };
}(children[i].className));
}
}

/**
* ## switchTab
*
* Switches tabs in the sidebar
*
* @param {string} tab The ID of the tab to switch to
*/
function switchTab(tab){
var tabEl = document.getElementById('sidebar_switch');
var children = tabEl.childNodes;

// Easiest way to go through tabs without any kind of selector is just to look at the tab bar
for(var i = 0, l = children.length; i < l; i += 1){
// Ignore text nodes
if(children[i].nodeType !== 1) continue;

// Figure out what tab pane this tab button corresponts to
var t = children[i].className.replace(/\s.*$/,'');
if(t === tab){
// Show the tab pane, select the tab button
document.getElementById(t).style.display = 'block';
if(children[i].className.indexOf('selected') === -1) children[i].className += ' selected';
}else{
// Hide the tab pane, deselect the tab button
document.getElementById(t).style.display = 'none';
children[i].className = children[i].className.replace(/\sselected/,'');
}
}

// Store the last open tab in localStorage
if(window.localStorage) window.localStorage.docker_sidebarTab = tab;
}

/**
* ## window.onload
*
* When the document is ready, make the sidebar and all that jazz
*/
window.onload = function(){
makeTree(tree, relativeDir, thisFile);
wireUpTabs();

// Switch to the last viewed sidebar tab if stored, otherwise default to folder tree
if(window.localStorage && window.localStorage.docker_sidebarTab){
switchTab(window.localStorage.docker_sidebarTab);
}else{
switchTab('tree');
}
};
Loading

0 comments on commit 442dcea

Please sign in to comment.