Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Features
Speaker Deck
PRO
Sign in
Sign up for free
Search
Search
DocumentUp @ JSMontreal
Search
jeromegn
February 15, 2012
Programming
1
200
DocumentUp @ JSMontreal
jeromegn
February 15, 2012
Tweet
Share
More Decks by jeromegn
See All by jeromegn
Isomorphism in web apps
jeromegn
1
89
Other Decks in Programming
See All in Programming
Design Foundational Data Engineering Observability
sucitw
3
190
詳解!defer panic recover のしくみ / Understanding defer, panic, and recover
convto
0
230
知っているようで知らない"rails new"の世界 / The World of "rails new" You Think You Know but Don't
luccafort
PRO
1
110
Zendeskのチケットを Amazon Bedrockで 解析した
ryokosuge
3
290
rage against annotate_predecessor
junk0612
0
160
Oracle Database Technology Night 92 Database Connection control FAN-AC
oracle4engineer
PRO
1
440
アセットのコンパイルについて
ojun9
0
120
AWS発のAIエディタKiroを使ってみた
iriikeita
1
180
さようなら Date。 ようこそTemporal! 3年間先行利用して得られた知見の共有
8beeeaaat
3
1.4k
🔨 小さなビルドシステムを作る
momeemt
4
670
ユーザーも開発者も悩ませない TV アプリ開発 ~Compose の内部実装から学ぶフォーカス制御~
taked137
0
150
Ruby×iOSアプリ開発 ~共に歩んだエコシステムの物語~
temoki
0
270
Featured
See All Featured
Code Review Best Practice
trishagee
70
19k
ReactJS: Keep Simple. Everything can be a component!
pedronauck
667
120k
It's Worth the Effort
3n
187
28k
Product Roadmaps are Hard
iamctodd
PRO
54
11k
Typedesign – Prime Four
hannesfritz
42
2.8k
A Modern Web Designer's Workflow
chriscoyier
696
190k
The Power of CSS Pseudo Elements
geoffreycrofte
77
6k
XXLCSS - How to scale CSS and keep your sanity
sugarenia
248
1.3M
The Pragmatic Product Professional
lauravandoore
36
6.9k
Scaling GitHub
holman
463
140k
Building a Modern Day E-commerce SEO Strategy
aleyda
43
7.6k
Bootstrapping a Software Product
garrettdimon
PRO
307
110k
Transcript
Instant documentation for your markdown
@jeromegn • Web Developer at DemandForce • Creator of Backbone
Todos • Jack of all trades
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
Config 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