Slide 1
Slide 1 text
2021 Oct 26
DocCͷυΩϡϝϯτΛ
Github PagesͰެ։͢Δ
Yappli Ͷ΄Γ΄Γ For Mobile Engineer @scenee
Slide 2
Slide 2 text
DocC
Slide 3
Slide 3 text
Documentation Compiler
Slide 4
Slide 4 text
Documentation Compiler
/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/docc
Slide 5
Slide 5 text
DocC
Documentation Compiler
• Xcodeͱ౷߹͞ΕͨυΩϡϝϯτπʔϧ
• In-source documentation: Doc comment and Documentation catalog
• ReferenceɾArticles ɾTutorials
• Swift Libraries(Frameworks/Packages)ͷΈରԠ
• Xcode Documentation WindowͱΣϒͰදࣔ
• Open source: github.com/apple/swift-docc
Slide 6
Slide 6 text
No content
Slide 7
Slide 7 text
No content
Slide 8
Slide 8 text
No content
Slide 9
Slide 9 text
No content
Slide 10
Slide 10 text
No content
Slide 11
Slide 11 text
DocC Archive
Slide 12
Slide 12 text
DocC Archive
Vue.js
Slide 13
Slide 13 text
DocC Archive
Slide 14
Slide 14 text
DocCͷυΩϡϝϯτΛ
WebͰެ։͢Δ
Slide 15
Slide 15 text
.htaccess
https://developer.apple.com/documentation/Xcode/distributing-documentation-to-external-developers
Slide 16
Slide 16 text
🤷
https://developer.apple.com/documentation/Xcode/distributing-documentation-to-external-developers
Slide 17
Slide 17 text
DocCͷυΩϡϝϯτΛ
Github Pages Ͱެ։͢Δ
Slide 18
Slide 18 text
No content
Slide 19
Slide 19 text
Github Pages Ͱ
ެ։Ͱ͖·ͤΜͰͨ͠
Slide 20
Slide 20 text
Github PagesͰެ։Ͱ͖ͳ͍😩
• DocCͷαΠτɺVuejsͷSingle-page application(SPA)
• Github PagesͰɺRewrite ruleΛઃఆͰ͖ͳ͍
• ύε͕ݻఆ example.com/documentation/package_name
• Rewrite͕ඞਢ
Slide 21
Slide 21 text
No content
Slide 22
Slide 22 text
No content
Slide 23
Slide 23 text
DocCͷυΩϡϝϯτΛ
GitHub PagesͰެ։͢Δ
Slide 24
Slide 24 text
DocCͷυΩϡϝϯτΛ
Firebase HostingͰެ։͢Δ
Slide 25
Slide 25 text
Firebase HostingͰ؆୯ 🎉
• ެ։ίϯςϯπΛDocC Archiveʹ͢Δͩ
͚
• σϑΥϧτͷRewriteઃఆͰOK
• Redirectઃఆ؆୯
Slide 26
Slide 26 text
floating-panel.web.app
Slide 27
Slide 27 text
ݱঢ়ͷ՝
Swift DocC Render
• ੩తϑΝΠϧαʔόʔͰϗεςΟϯάͰ͖ͳ͍
• ϧʔςΟϯά͕ϧʔτύε͔Βݻఆ͞Ε͍ͯΔ(ઃఆͰ͖ͳ͍)
• swift-docc-render: github.com/apple/swift-docc-render/src/routes.js
• 1ͭͷαΠτͰෳόʔδϣϯͷϗετςΟϯά͕Ͱ͖ͳ͍
Announcing Swift-DocC forums.swift.org/t/announcing-swift-docc/52797
Slide 28
Slide 28 text
Wrap up
DocCͰੜͨ͠υΩϡϝϯτΛGithub PagesͰެ։͢Δ
• DocC: Xcodeͱ౷߹͞ΕͨυΩϡϝϯτπʔϧ
• υΩϡϝϯτΣϒެ։Ͱ͖Δ
• Firebase HostingͰ؆୯ʹެ։Ͱ͖Δ
• Open SourceͰͷվળʹظ
Slide 29
Slide 29 text
References
• DocC developer.apple.com/documentation/DocC
• Swift-DocC: swift.org/blog/swift-docc/
• Meet DocC documentation in Xcode - WWDC21 developer.apple.com/videos/play/
wwdc2021-10166
• Elevate your DocC documentation in Xcode - WWDC21 developer.apple.com/videos/play/
wwdc2021-10167
• Host and automate your DocC documentation - WWDC21 developer.apple.com/videos/play/
wwdc2021-10236
• Build interactive tutorials using DocC - WWDC21 developer.apple.com/videos/play/
wwdc2021-10235