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.4k
카피캣으로 시작하는 오픈소스
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
190
개발자 커리어 : 두려움이 이끄는 대로
ahnseonghyun
0
1.5k
개발자는 어떤 일을 하는 걸까?
ahnseonghyun
0
420
SQLAlchemy CustomTypes
ahnseonghyun
0
890
5번째 회사 그리고 레이니스트
ahnseonghyun
0
210
리부트 : 경력자에게도 수습이 필요한 순간
ahnseonghyun
0
2.3k
MQTT 를 이용한 주문 시스템 개선
ahnseonghyun
0
1.1k
CNN MNIST Tutorial
ahnseonghyun
0
72
github:유용한 기능들
ahnseonghyun
0
1.7k
Other Decks in Programming
See All in Programming
AWS CDKを用いたセキュアなCI/CDパイプラインの構築 / Build a secure CI/CD pipeline using AWS CDK
seike460
PRO
3
500
実践Dash - 手を抜きながら本気で作るデータApplicationの基本と応用 / Dash for Python and Baseball
shinyorke
2
220
pytest プラグインを開発して DRY に自動テストを書こう
inuatsu
2
240
AWS Lambda Web Adapterを活用する新しいサーバーレスの実装パターン
tmokmss
6
5.4k
Taking LLMs out of the black box: A practical guide to human-in-the-loop distillation
inesmontani
PRO
3
1.1k
個人開発で使ってるやつを紹介する回
yohfee
1
640
Removing Corepack
yosuke_furukawa
PRO
9
1.1k
型付きで行うVSCode拡張機能開発 / VSCode Meetup #31
mazrean
0
210
ポケモンで考えるコミュニケーション / Communication Lessons from Pokémon
mackey0225
4
140
Assembling the Future: crafting the missing pieces of the Ruby on Wasm puzzle
skryukov
0
120
GraphQLとGigaViewer for Apps
numeroanddev
4
880
CSC305 Lecture 01
javiergs
PRO
1
140
Featured
See All Featured
Fontdeck: Realign not Redesign
paulrobertlloyd
81
5.2k
ParisWeb 2013: Learning to Love: Crash Course in Emotional UX Design
dotmariusz
109
6.9k
The Art of Delivering Value - GDevCon NA Keynote
reverentgeek
4
98
Sharpening the Axe: The Primacy of Toolmaking
bcantrill
37
1.7k
Side Projects
sachag
452
42k
The Myth of the Modular Monolith - Day 2 Keynote - Rails World 2024
eileencodes
5
220
Build The Right Thing And Hit Your Dates
maggiecrowley
31
2.3k
Web Components: a chance to create the future
zenorocha
310
42k
WebSockets: Embracing the real-time Web
robhawkes
59
7.3k
Visualization
eitanlees
143
15k
XXLCSS - How to scale CSS and keep your sanity
sugarenia
246
1.3M
Designing for humans not robots
tammielis
249
25k
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