mkdocの使用法の説明。

Homebrew の簡易パッケージを作成するコマンドラインツール。

使い方

インストール方法

# -- 関連ツール並びに、mkdocのtapを追加
# - ShellScriptのコンパイル用
brew tap mknclab/shcnv
# - Homebrewのテンプレート群を内包したツール
brew tap mknclab/hbprt
# - 翻訳ファイルの生成及び、Tagの反映
brew tap mknclab/setpush
# - ShellScript 内の使われてない変数を割り出すツール
brew tap mknclab/scc
# -- この項目本来のmkdocを追加
brew tap mknclab/mkdoc && brew install mkdoc

初期設定

# このツールは生成に必要なディレクトリ構造を初期設定を行うことで生成します。
# また、該当ディレクトリ以外では生成出来ない仕組みにしており、ファイル名を弄らない限り生成エラーが出ることはありません。
# 初期設定 / コマンドの引数の順番は以下の通りです。
# mkdoc --init [ CURRENT DIR ] [ Github Name ]
例) mkdoc --init . Github-Username

基本機能 ( git push するまでの手順に沿って説明します。)

手順 1, パッケージ生成 ( shを選択してなければ 手順 3 へ )
# パッケージ用リポジトリの生成には以下のオプションと引数を入力して下さい。
# 生成中に Description や License を選択する項目が表示されます。
# FILETYPE は他の言語名を入力するとShellScriptのテンプレートが選択されず、
# コンパイル用のディレクトリ構造だけが生成されます。
# mkdoc --prototype [ REPOSITORY ] [ FILETYPE / sh | bash | * ]
例) mkdoc --prototype example bash
手順 2, パッケージのロケールファイルを生成
# './example-devel.sh' を用いて ShellScriptの gettext 項目から翻訳ファイルを生成します。
# ロケールファイルの生成には以下のオプションと引数を入力して下さい。
# mkdoc --translate convert [ REPOSITORY ] [ VERSION ]
例) mkdoc --translate convert example 1.0.0
# './_source/example' 内にコンパイル用にShellScriptをコピーします。
# mkdoc --translate copy [ REPOSITORY ]
例) mkdoc --translate copy example
手順 3, コンパイル用ファイルを生成します。
# configure.ac などの生成には以下のオプションと引数を入力して下さい。
# mkdoc --add [ REPOSITORY ] [ VERSION ] [ EDITOR / vim | emacs | nano | less ]
例) mkdoc --add example 1.0.0 less
手順 4, Githubでリリースする場合
# リモートリポジトリに push した後にハッシュ値を入力します。
# タグの生成には以下のオプションと引数を入力して下さい。
# mkdoc --gittags push [ REPOSITORY ] [ VERSION ] [ HASH ]
例) mkdoc --gittags push example 1.0.0 xxxxxxx
# リモートリポジトリからタグを削除する。
# タグの削除には以下のオプションと引数を入力して下さい。
# mkdoc --gittags del [ REPOSITORY ] [ VERSION ]
例) mkdoc --gittags del example 1.0.0
# タグ一覧を表示する。
# タグ一覧の表示には以下のオプションと引数を入力して下さい。
# mkdoc --gittags list [ REPOSITORY ]
例) mkdoc --gittags list example

その他の機能

・初期設定ファイルの編集
# 初期設定で入力したGithubユーザ名やコピーライトなどを記録したファイルを編集します。
# mkdoc --edit [ EDITOR / vim | emacs | nano ]
例) mkdoc --edit vim
・初期設定ファイルの表示
# 初期設定で入力したGithubユーザ名やコピーライトなどを記録したファイルを表示します。
例) mkdoc --view
・リポジトリ内の文字列置換
# 先に編集したコピーライトなどをリポジトリに反映させます。
# mkdoc --change [ REPOSITORY ] [ FILETYPE / sh | bash | * ]
例) mkdoc --change example bash
・ローカルリポジトリの削除
# カレントディレクトリ上のローカルリポジトリを削除します。
# mkdoc --remove [ REPOSITORY ] [ VERSION ]
例) mkdoc --remove example 1.0.0
・未使用変数の割り出し(シェルスクリプト専用)
# シェルスクリプト内で、使用していないまたは削除していない変数を割り出します。
# mkdoc --check [ REPOSITORY ]
例) mkdoc --check example

更新履歴

ライセンス

MIT lincense
%d人のブロガーが「いいね」をつけました。