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
카피캣으로 시작하는 오픈소스
Search
AhnSeongHyun
October 25, 2015
Programming
0
1.3k
카피캣으로 시작하는 오픈소스
Introduction of Plate(python slate : API Documentation Tool based markdown)
AhnSeongHyun
October 25, 2015
Tweet
Share
More Decks by AhnSeongHyun
See All by AhnSeongHyun
Django ORM에서는 어떻게 SQL Where절 조건 순서를 고정할 수 있을까?
ahnseonghyun
0
120
개발자 커리어 : 두려움이 이끄는 대로
ahnseonghyun
0
1.4k
개발자는 어떤 일을 하는 걸까?
ahnseonghyun
0
380
SQLAlchemy CustomTypes
ahnseonghyun
0
850
5번째 회사 그리고 레이니스트
ahnseonghyun
0
200
리부트 : 경력자에게도 수습이 필요한 순간
ahnseonghyun
0
2.2k
MQTT 를 이용한 주문 시스템 개선
ahnseonghyun
0
1.1k
CNN MNIST Tutorial
ahnseonghyun
0
55
github:유용한 기능들
ahnseonghyun
0
1.7k
Other Decks in Programming
See All in Programming
両面どころかインフラもTSでできるよ ~ 全方位TypeScriptによるプロダクト開発 ~
myfinder
9
2.4k
DDDはなぜ難しいのか / 良いコードの定義と設計能力の壁
pospome
24
7.5k
オブジェクト指向コードレビューの新しいアプローチ
akkie76
3
1.5k
AppDeveloperCon 2024 EU: Building polyglot developer experiences in 2024
salaboy
0
380
今の SmartHR にエンジニアで入社するとどうなるの?
daisukeshinoku
3
1.4k
object-oriented-conference-2024
fuwasegu
6
1.9k
TDDと今まで
kanayannet
0
140
The Future of C++ Interoperability: Insights from Porting a Game to Swift
teamhimeh
0
280
導入から5年が経って見えた Datadog APM 運用の課題
bgpat
2
540
Go1.22からの疑似乱数生成器について/go-122-pseudo-random-generator
convto
1
160
Open Source Swiftc Workshop
kitasuke
1
290
Cloud RunとCloud PubSubでサーバレスなデータ基盤2024 with Terraform / Cloud Run and PubSub with Terraform
shinyorke
7
1.9k
Featured
See All Featured
5 minutes of I Can Smell Your CMS
philhawksworth
199
19k
Understanding Cognitive Biases in Performance Measurement
bluesmoon
6
950
The MySQL Ecosystem @ GitHub 2015
samlambert
242
12k
Ruby is Unlike a Banana
tanoku
95
10k
Building Flexible Design Systems
yeseniaperezcruz
317
37k
Building Your Own Lightsaber
phodgson
97
5.6k
Scaling GitHub
holman
456
140k
What the flash - Photography Introduction
edds
64
11k
Robots, Beer and Maslow
schacon
PRO
154
7.9k
Music & Morning Musume
bryan
39
5.5k
GraphQLとの向き合い方2022年版
quramy
28
12k
Infographics Made Easy
chrislema
237
18k
Transcript
ೖமਵ۽ दೞח য়ࣗझ ash84
ash84 • Developer •
[email protected]
• ash84.net • @sh84ahn •
github.com/AhnSeongHyun
۠ ۽ંܳ ೞҊ णפ. • Plate : API Documentation Tool
based on markdown. • https://github.com/Plate-Project/plate • http://plate-project.github.io/
ѐߊೞѱ ػ ҅ӝ • ੑࢎ 3ѐਘର(नੑ ইש), ೠହ ݅ খࢸ
दӝ • API স , ࢸ҅ ୡউ সҗ ೣԋ API ޙࢲച ో ઑࢎ • Ѿઁ ҙ۲ API ࢎٜਸ ۽ ଵҊ
more test • Swagger • http://petstore.swagger.io/ • I/O Docs •
https://github.com/mashery/iodocs • http://blog.outsider.ne.kr/990
more doc • Slate • https://github.com/tripit/slate • Atlassian/Confulence
Stripe API Docs
ҶҶҶ • ӝઓߑध - *.docx, *.xlsx + sample code •
asp.net_example.zip, jsp_example.zip • সؘо औ ঋ.
ҶҶҶ • Stripe э API ޙࢲച ࢎܳ ਊೞݶ.. • API
ܳ पઁ ٘৬ ೣԋ ࠅࣻ ח . • APIܳ সؘ ೞ؊ۄب, ખ ؊ औѱ ޙࢲ৬ ٘ܳ э সؘ оמ.
ց - slate • slate ۽ ೞҊ ಝࠁӝ द. •
য, Ѥ ܖ࠺. ܖ࠺ח ࢎیੑפ.
࠙ࢳ • ҳࢿ • middleman : static site generator based
Ruby • layout.erb - మ݁ • index.md - APIޙࢲ • ѾҴ.. 1. index.md ਸ ߸ജ 2. middleman ਸ ਊ೧ࢲ layout.erb ী ֍Ҋ 3. HTML ۽ ۱.
conv2python • ખ؊ ࣼೠ য৬ ജ҃ ࢎਊ. ࢎप slate
ج۰ࠁ ࢲ… • ղ য۽ ॆਸ Ҋ ח ࢚క • ܖ࠺৬ о ࠺तೠ?
conv2python • Middleman TO Flask • jinja2 template •
layout.erb to /templates/index.html
conv2python • markdown to html • markdown : ߸ജ
߂ নೠ ഛ ݽٕ ઁҕ • fence_codes : markdown code block to <pre></pre> • tables : markdown table syntax to <table></table> import markdown return markdown.markdown(md_text, extensions=["fenced_code", "tables"])
conv2python ```python codes ``` ```java codes ```
<pre class="highlight python"> codes </pre> <pre class="highlight java"> codes </pre> markdown html
conv2python • Code Syntax Highlighting • pygments : Python
syntax highlighter • নೠ ۽Ӓې߁ & ݃স য ޙߨ ਗ from pygments import highlight from pygments.lexers import PythonLexer from pygments.lexers import JavaLexer from pygments.formatters import HtmlFormatter highlighted = highlight(code, PythonLexer(), HtmlFormatter()) highlighted = highlight(code, JavaLexer(), HtmlFormatter())
߸ജೞҊ, ֍ਵݶ, .
slate-flask ۽ github ҕѐ • ਬ : • ইө. •
աۢ Ruby ী ࣼೞ ঋ ࢎۈب ঋਸө. ҕѐ ೞա݃ա. য়݅ ػ. • ॶҔਸ ইࠁ. ইפ ղо ॳ. ঌ߄ೞח ࢲߡAPI ޙࢲചী ਊ. • ॄࠁפ, উજ ࠗ࠙ ࠁӝ द.
ӝמ୶о • ݣ౭ ݃ ӝמ ୶о • watchdog ӝמ ୶о
ݣ౭ ݃ ӝמ • ഋചػ ٣۩షܻо ইצ ࢎਊо ҃۽ܳ .
• ݾର ࢚ী दغח ࣽࢲب ೞب۾ . • index.json { "ORDER": [ "Introduction.md", "Signup.md", "Signin.md", "Notice.md", "Notice.jp.md", "Notice.fr.md" ] }
• ݅ড, API ޙࢲо ࣻػݶ? • ࢲߡܳ Տ. • API
ޙࢲܳ Ҋ. • द ࢲߡܳ ৢܽ. • ޙࢲܳ ࣻೞݶ ߄۽ ࢲߡо زਵ۽ ੋध೧ࢲ ղਊਸ ߄Լ.
watchdog • ࢲߡ۽ ڸݶ, ߄۽ хद द. • ޙࢲо ߸҃غݶ,
ਃद द html ٜ݅ӝ ࣻ೯
EMOCON 2015 F/W ળ࠺ೞݶࢲ ୶оೠ ղਊٜ. • slate-flask to Plate-Project/plate
: organization • postman2md • multi-language searching • static html
ࢲߡ API ѐߊद ಁఢ • ࢎਊೠ పझਸ ޙࢲ۽ ٜ݅ࣻ
ঋਸө? postman2md • postman collection json ਸ markdown ਵ۽ ߸ജ • ߸ജػ markdown ਸ ޙࢲചী ਊ(plateী ਊ) • postman collection json with plate testing "1* %FTJHO doc dev
Ѩ࢝ ޙઁ : lunr.js ਊ • য݅ਸ ਗೞח ޙઁ, Ҵয
ਗ ग • lunr-languages ܳ plate ী োز, ݻ ѐ Ҵয Ѩ࢝ оמ. • അ ೠҴযо হযࢲ lunr.kr.js ܳ ٜ݅Ҋ ח
static html • ࢎप ѱ ࢤпೞ ঋও؍ ӝמ. • github.io
э Ҕী ৢܻѢա Apacheী ৢܽݶ • ਗې Flask ח jinja2 template ܳ ਊ, ߸ജػ HTML ਸ • http://plate-project.github.io/
খਵ۽ ҅ദ • ী٣ఠ • పझࠗ࠙ ୶о : slateীب Բળೠ
ग • ೖம ఎೖ - Front-End • ઑӘ ܲ ߑೱਵ۽ API Documentation Toolਸ ٜ݅Ҋ र.
য়ࣗझ दೞӝ • ٘સӝ vs. ೖம • ױ ח ٠,
ѐੋ ࢿೱ
যڌѱ ҅ࣘ ਬೡࣻ חо? • ೠߣ दೠѪਸ ҅ࣘ ਬೞחѪ औо
ঋ. • ౠ ೖம ؊ Ӓ۠٠. • ॄࠁҊ ҅ࣘ ѐࢶೡ Ѣܻܳ ݅٘ח Ѫ ӓ ؽ. • ࣘਵ۽ ೡࣻ חѪਸ ࢶఖೞӡ.
ெࠁҊ ӝ. • issue, pull request • ਃೠ ӝמٜਸ
ইղח .
যڌѱ જ য়ࣗझо ؼࣻ ਸө? • fork count? star? •
ৈ ݽܰѷ. ࣼઁ • ইоח җ
For me • ࣘਵ۽ ѐߊೡ Ѣܻ, daily commit • ҙ۲ػ
নೠ য়ࣗझী ೠ Ӕ.
Thank you