DocumentUp @ JSMontreal

Instant documentation for your markdown

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

Quick demo

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

Two versions

Version 1: All front-end

Ender.js

Assemble your own framework

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

npm install -g ender ender build bonzo qwery reqwest bean

Github (JSONP) API

marked.js is fast

localStorage as a cache

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

Version 2: All back-end

Hosted

Conﬁg documentup.json

Post-Receive Hook

On-demand

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

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(); } } });

gh-pages <!DOCTYPE html> <html> <head> <script src="documentup.min.js"></script> <script> DocumentUp.document("username/repository"); </script>
</head> <body></body> </html>

200 KB+ to 0.5 KB

Open source jeromegn/DocumentUp

Thank you

DocumentUp @ JSMontreal

DocumentUp @ JSMontreal

jeromegn

More Decks by jeromegn

Other Decks in Programming

Featured

Transcript

Instant documentation for your markdown

@jeromegn • Web Developer at DemandForce • Creator of Backbone

Quick demo

Why?

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

Two versions

Version 1: All front-end

Ender.js

Assemble your own framework

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

npm install -g ender ender build bonzo qwery reqwest bean

Github (JSONP) API

marked.js is fast

localStorage as a cache

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

Version 2: All back-end

Hosted

Conﬁg documentup.json

Post-Receive Hook

On-demand

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

JSONP $.ajax({ url: "http://documentup.com/compiled", dataType: "jsonp", data: { content: "#

gh-pages <!DOCTYPE html> <html> <head> <script src="documentup.min.js"></script> <script> DocumentUp.document("username/repository"); </script>

200 KB+ to 0.5 KB

Open source jeromegn/DocumentUp

Thank you