Skip to content

Instantly share code, notes, and snippets.

@mhkeller
Last active August 29, 2015 14:27
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save mhkeller/b5e9953759dab37f74f4 to your computer and use it in GitHub Desktop.
Save mhkeller/b5e9953759dab37f74f4 to your computer and use it in GitHub Desktop.
Example js workbook syntax

Comment blocks are concatenated as markdown, or could have specific styling per JSDoc identifiers

/*
* ## Load our dependencies
*/
var io = require('indian-ocean')

/*
* ## Read in data
* We load in our json data
*/
var data = io.readDataSync('data.json')

/*
* @returns {format=table} data
*/

You could also do peek shorthand or have options

/*
* ## Load our dependencies
*/
var io = require('indian-ocean')

/*
* ## Read in data
* We load in our json data
*/
var data = io.readDataSync('data.json')

/*
* @csv data
* @csv [head=10] data
*/

You could do the same for svg

var document = require('jsdom').jsdom()

var svg = d3.select(document.body).append('svg')

svg.append('circle').attr('r', 5).style('fill', 'red')

/*
* @svg svg
*/

Unknown async stuff

/*
* ## Read in data asyncly
* 
*/
io.readData('data.json', function(err, data){
/*
* @csv data
* @csv [head=10] data
*/
})

Or

/*
* ## Read in data asyncly
* 
*/
io.readData('data.json', callback)

function callback(err, data){
  /*
  * @csv data
  * @csv [head=10] data
  */
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment