公式ドキュメントの裏側を知る〜DocCを支える技術たち〜 by チャリオ

iOSDC Japan 2024
レギュラートーク(20分)

公式ドキュメントの裏側を知る〜DocCを支える技術たち〜

charlie_dev_ios チャリオ charlie_dev_ios
1

iOSエンジニアであれば誰しも一度はApple公式のドキュメントやSwiftUIのチュートリアルを読んだり、プロダクトやライブラリのドキュメントをDocCを用いて書いたりしたことがあるのではないでしょうか。swift-doccはこれらのドキュメント生成をSwiftベースで実現する強力なライブラリです。

本トークではswift-doccの仕組みに着目し、その動作原理について解説します。ドキュメント作成にはシンボル生成やMarkdownのパースなど、普段のアプリ開発ではあまり触れる機会のない技術が関わっています。それらについても一つずつ丁寧に取り上げます。

このトークを通じて、swift-doccのコードを理解し、OSS貢献やSwiftを使用したツール開発への第一歩を一緒に踏み出しましょう!

内容

  • DocCの概要
  • APIリファレンスや記事、チュートリアルを生成するまでの流れ
  • ArgumentParserについて
  • SymbolKit、swift-markdown、swift-docc-render、swift-nioなど重要な構成要素について
    • 記事(Article)の生成方法
    • .tutorialファイルのパース方法
    • Web上でのプレビュー機能の仕組み
  • swift-doccの本当の役割