DocumentUp @ JSMontreal

Slide 1

Slide 1 text

Instant documentation for your markdown

Slide 2

Slide 2 text

@jeromegn • Web Developer at DemandForce • Creator of Backbone Todos • Jack of all trades

Slide 3

Slide 3 text

Quick demo

Slide 4

Slide 4 text

Why?

Slide 5

Slide 5 text

Usage DocumentUp.document({ repo: "jeromegn/documentup", name: "DocumentUp", twitter: [ "jeromegn", "DocumentUp" ] });

Slide 6

Slide 6 text

Two versions

Slide 7

Slide 7 text

Version 1: All front-end

Slide 8

Slide 8 text

Ender.js

Slide 9

Slide 9 text

Assemble your own framework

Slide 10

Slide 10 text

Bonzo: DOM Qwery: Selectors Bean: DOM Events Reqwest: AJAX Components

Slide 11

Slide 11 text

npm install -g ender ender build bonzo qwery reqwest bean

Slide 12

Slide 12 text

Github (JSONP) API

Slide 13

Slide 13 text

marked.js is fast

Slide 14

Slide 14 text

localStorage as a cache

Slide 15

Slide 15 text

window.localStorage.setItem(“username/repository”, html) window.localStorage.getItem(“username/repository”)

Slide 16

Slide 16 text

Version 2: All back-end

Slide 17

Slide 17 text

Hosted

Slide 18

Slide 18 text

Conﬁg documentup.json

Slide 19

Slide 19 text

Post-Receive Hook

Slide 20

Slide 20 text

On-demand

Slide 21

Slide 21 text

POST curl -X POST --data-urlencode [email protected] \ http://documentup.com/compiled > index.html && open index.html

Slide 22

Slide 22 text

JSONP $.ajax({ url: "http://documentup.com/compiled", dataType: "jsonp", data: { content: "# test", name: "Test JSONP!" }, success: function(resp){ // `status` is always provided if (resp.status == 200) { // Write to your document document.open(); document.write(resp.html); document.close(); } } });