Save 37% off PRO during our Black Friday Sale! »

DocCのドキュメントをGithub Pagesで公開する

DocCのドキュメントをGithub Pagesで公開する

0e726052fdb28ba1c004aa90eccbe261?s=128

Shin Yamamoto

October 26, 2021
Tweet

Transcript

  1. 2021 Oct 26 DocCͷυΩϡϝϯτΛ Github PagesͰެ։͢Δ Yappli Ͷ΄Γ͸΄Γ For Mobile

    Engineer @scenee
  2. DocC

  3. Documentation Compiler

  4. Documentation Compiler /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/docc

  5. 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
  6. None
  7. None
  8. None
  9. None
  10. None
  11. DocC Archive

  12. DocC Archive Vue.js

  13. DocC Archive

  14. DocCͷυΩϡϝϯτΛ WebͰެ։͢Δ

  15. .htaccess https://developer.apple.com/documentation/Xcode/distributing-documentation-to-external-developers

  16. 🤷 https://developer.apple.com/documentation/Xcode/distributing-documentation-to-external-developers

  17. DocCͷυΩϡϝϯτΛ Github Pages Ͱެ։͢Δ

  18. None
  19. Github Pages Ͱ͸ ެ։Ͱ͖·ͤΜͰͨ͠

  20. Github PagesͰެ։Ͱ͖ͳ͍😩 • DocCͷαΠτ͸ɺVuejsͷSingle-page application(SPA) • Github PagesͰ͸ɺRewrite ruleΛઃఆͰ͖ͳ͍ •

    ύε͕ݻఆ example.com/documentation/package_name • Rewrite͕ඞਢ
  21. None
  22. None
  23. DocCͷυΩϡϝϯτΛ GitHub PagesͰެ։͢Δ

  24. DocCͷυΩϡϝϯτΛ Firebase HostingͰެ։͢Δ

  25. Firebase HostingͰ͸؆୯ 🎉 • ެ։ίϯςϯπΛDocC Archiveʹ͢Δͩ ͚ • σϑΥϧτͷRewriteઃఆͰOK •

    Redirectઃఆ΋؆୯
  26. floating-panel.web.app

  27. ݱঢ়ͷ՝୊ 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
  28. Wrap up DocCͰੜ੒ͨ͠υΩϡϝϯτΛGithub PagesͰެ։͢Δ • DocC: Xcodeͱ౷߹͞ΕͨυΩϡϝϯτπʔϧ • υΩϡϝϯτ͸΢Σϒ΁ެ։Ͱ͖Δ •

    Firebase HostingͰ؆୯ʹެ։Ͱ͖Δ • Open SourceͰͷվળʹظ଴
  29. 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