APIドキュメント「slate」をwindows10で構築する手順

windows10環境でRubyで開発されたの静的サイトジェネレーターでAPIドキュメントが作成できる「slate」をインストールして実行するまでの手順を記述してます。

※windows10にrubyのインストール手順はこちら

まずは、gitからforkしてダウンロードします。

こちらのサイトからforkします。

forkしたものをcloneします。

git clone https://github.com/yourgitname/slate.git

slateプロジェクトを作成します。

まずは移動します。

cd slate

slateフォルダ内は下図となります。

インストールを行います。

bundle install

自分の場合は下記のエラーが発生しました。

Ruby (< 2.7.dev, >= 2.3), which is required by gem 'nokogiri (~> 1.10.8)', is
not available in the local ruby installation

nokogiriのバージョンを確認して「Gemfile」を編集して解決しました。

nokogiri -v

<出力結果>
# Nokogiri (1.10.10)

「Gemfile」編集

gem 'nokogiri', '~> 1.10.10'

再度実行すると正常にインストールは完了しました。

bundle install

slateを起動します。

bundle exec middleman server

ブラウザから http://IPアドレス:4567にアクセスするとフロント画面が表示されます。
API Blueprintもいいですが、こちらもなかなかレイアウトがしかっりしててよさげです。

静的ファイルの生成はbuildコマンドで行います。

bundle exec middleman build

buildフォルダが作成されて、中に静的ファイルが生成されます。

ページの編集はsourceフォルダ配下にある「index.html.md」を編集します。