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
81
Other Decks in Programming
See All in Programming
バッチを作らなきゃとなったときに考えること
irof
2
460
Visual StudioのGitHub Copilotでいろいろやってみる
tomokusaba
1
180
PHP ステートレス VS ステートフル 状態管理と並行性 / php-stateless-stateful
ytake
0
110
PRレビューのお供にDanger
stoticdev
1
210
Generating OpenAPI schema from serializers throughout the Rails stack - Kyobashi.rb #5
envek
1
160
AIの力でお手軽Chrome拡張機能作り
taiseiue
0
180
JavaScriptツール群「UnJS」を5分で一気に駆け巡る!
k1tikurisu
9
1.8k
密集、ドキュメントのコロケーション with AWS Lambda
satoshi256kbyte
1
210
Honoとフロントエンドの 型安全性について
yodaka
7
1.4k
Djangoアプリケーション 運用のリアル 〜問題発生から可視化、最適化への道〜 #pyconshizu
kashewnuts
1
250
GitHub Actions × RAGでコードレビューの検証の結果
sho_000
0
280
Lottieアニメーションをカスタマイズしてみた
tahia910
0
130
Featured
See All Featured
Product Roadmaps are Hard
iamctodd
PRO
50
11k
Fontdeck: Realign not Redesign
paulrobertlloyd
83
5.4k
Building Adaptive Systems
keathley
40
2.4k
Art, The Web, and Tiny UX
lynnandtonic
298
20k
Let's Do A Bunch of Simple Stuff to Make Websites Faster
chriscoyier
507
140k
Designing for Performance
lara
604
68k
Six Lessons from altMBA
skipperchong
27
3.6k
Fireside Chat
paigeccino
34
3.2k
10 Git Anti Patterns You Should be Aware of
lemiorhan
PRO
656
59k
A Tale of Four Properties
chriscoyier
158
23k
Producing Creativity
orderedlist
PRO
344
39k
Making the Leap to Tech Lead
cromwellryan
133
9.1k
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 content@README.md \ 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