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
·
SiteGround - Reliable hosting with speed, security, and support you can count on.
→
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
AIチームを指揮するOSS「TAKT」活用術 / How to Use “TAKT,” an OSS Tool for Orchestrating AI Teams
nrslib
6
770
Lessons from Spec-Driven Development
simas
PRO
0
110
Copilot CLI の継戦能力を高める コンテキスト管理
nozomutu
1
1.1k
oxlintはeslint/typescript-eslintを置き換えられるのか
shomafujita
2
300
Inspired By RubyKaigi (EN)
atzzcokek
0
480
RTSPクライアントを自作してみた話
simotin13
0
410
ReactとSvelteのその先、Ripple-TS / Beyond React and Svelte: Ripple-TS
ssssota
3
1.9k
AIとRubyの静的型付け
ukin0k0
0
500
AI駆動開発で崩れていくコードベースを立て直す
kyoko_nr_nr
1
410
今さら聞けないCancellationToken
htkym
0
210
CLIであることを活かしたGitHub Copilot CLI活用術 / GitHub Copilot CLI Pro Tips & Tricks
nao_mk2
1
1.2k
AI時代のUIはどこへ行く?その2!
yusukebe
18
6k
Featured
See All Featured
Optimizing for Happiness
mojombo
378
71k
More Than Pixels: Becoming A User Experience Designer
marktimemedia
3
430
Discover your Explorer Soul
emna__ayadi
2
1.1k
Bridging the Design Gap: How Collaborative Modelling removes blockers to flow between stakeholders and teams @FastFlow conf
baasie
0
570
[SF Ruby Conf 2025] Rails X
palkan
2
1.1k
Fashionably flexible responsive web design (full day workshop)
malarkey
408
66k
The Art of Programming - Codeland 2020
erikaheidi
57
14k
Why Our Code Smells
bkeepers
PRO
340
58k
Building Applications with DynamoDB
mza
96
7.1k
Leadership Guide Workshop - DevTernity 2021
reverentgeek
1
290
How to build a perfect <img>
jonoalderson
1
5.5k
Fantastic passwords and where to find them - at NoRuKo
philnash
52
3.7k
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