Takahiro Octopress Blog

-1から始める情弱プログラミング

.jazzy.yamlを使ってコマンドを省略しよう！

はじめに

約3年前にjazzyを利用していました。
(以前の記事：jazzyを使って、Swiftで書いたプロジェクトのリファレンスを自動生成しよう！)

今回、久々に jazzy を触ってみて .jazzy.yaml を利用する機会があったので、その時のメモを書き記しておきます。

.jazzy.yaml

では早速、 .jazzy.yaml の書き方を見ていきます。
作成する階層はアプリのプロジェクトの xcodeproj と同階層です。

実際の .jazzy.yaml は下記のようになります。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

# .jazzy.yaml

# ドキュメント化するスコープ
min_acl: private

# 出力先フォルダをクリーンするか否か
clean: true

# 出力先フォルダの指定
output: docs

# 作成者の名前
author: Takahiro

# 作成者のURL
author_url: https://grandbig.github.io

# ドキュメント化する対象モジュールの名称
module: JazzySample

# ドキュメントコメントのないファイルはスキップするか否か
skip_undocumented: true

# ドキュメントにつけるバージョン番号
module_version: 1.0

# コピーライト
copyright: © 2019 - Takahiro - Powered by Octopress

# ドキュメントのテーマ(apple/fullWidth/jonyの3つから選択可能)
theme: apple

このように定義しておけば実行するときのコマンドは

1

$ jazzy

で済みます。

まとめ

今回は簡単に .jazzy.yaml の書き方についてまとめました。
本日はここまで。

Comments