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
Sponsored
·
Ship Features Fearlessly
Turn features on and off without deploys. Used by thousands of Ruby developers.
→
jeromegn
February 15, 2012
Programming
210
1
Share
DocumentUp @ JSMontreal
jeromegn
February 15, 2012
More Decks by jeromegn
See All by jeromegn
Isomorphism in web apps
jeromegn
1
100
Other Decks in Programming
See All in Programming
Oxcを導入して開発体験が向上した話
yug1224
4
270
RailsTokyo 2026#4: AI様があれば、 Hotwireの弱点は消えるか?
naofumi
5
1k
LLM Plugin for Node-REDの利用方法と開発について
404background
0
150
Old Dog, New Tricks: The Java 25 Reinvention - JNation
bazlur_rahman
0
140
タクシーアプリ『GO』の バックエンド開発のおける AI利活用と若者のすべて
pyama86
3
1.8k
プロパティの順序で型推論が壊れる!? TypeScript6.0の修正からContext-Sensitivityの仕組みを追う
bicstone
2
1.3k
AI 時代のソフトウェア設計の学び方
masuda220
PRO
29
11k
dRuby over BLE
makicamel
1
240
Inside Stream API
skrb
1
520
Oxlintのカスタムルールの現況
syumai
5
940
RTSPクライアントを自作してみた話
simotin13
0
410
[KCD Czech] eBPF Meets the GPU: Future of AI Infra Observability
doniacld
0
130
Featured
See All Featured
StorybookのUI Testing Handbookを読んだ
zakiyama
31
6.8k
The Art of Programming - Codeland 2020
erikaheidi
57
14k
How to optimise 3,500 product descriptions for ecommerce in one day using ChatGPT
katarinadahlin
PRO
1
3.6k
Lessons Learnt from Crawling 1000+ Websites
charlesmeaden
PRO
1
1.3k
Why You Should Never Use an ORM
jnunemaker
PRO
61
9.9k
Templates, Plugins, & Blocks: Oh My! Creating the theme that thinks of everything
marktimemedia
31
2.8k
Building an army of robots
kneath
306
46k
Leading Effective Engineering Teams in the AI Era
addyosmani
9
2k
The SEO Collaboration Effect
kristinabergwall1
1
470
A designer walks into a library…
pauljervisheath
211
24k
A Tale of Four Properties
chriscoyier
163
24k
SEO in 2025: How to Prepare for the Future of Search
ipullrank
3
3.5k
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