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

windows10環境でRubyで開発されたの静的サイトジェネレーターでAPIドキュメントが作成できる「slate」をインストールして実行するまでの手順を記述してます。
環境
- OS windows10 pro 64bit
- ruby 2.7.1
- gem 3.0.3
※windows10にrubyのインストール手順はこちら
slateインストール
まずは、gitからforkしてダウンロードします。
こちらのサイトからforkします。

forkしたものをcloneします。
1 |
git clone https://github.com/yourgitname/slate.git |
slateプロジェクト作成
slateプロジェクトを作成します。
まずは移動します。
1 |
cd slate |
slateフォルダ内は下図となります。

インストールを行います。
1 |
bundle install |
自分の場合は下記のエラーが発生しました。
1 2 |
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」を編集して解決しました。
1 2 3 4 |
nokogiri -v <出力結果> # Nokogiri (1.10.10) |
「Gemfile」編集
1 |
gem 'nokogiri', '~> 1.10.10' |
再度実行すると正常にインストールは完了しました。
1 |
bundle install |
slate起動
slateを起動します。
1 |
bundle exec middleman server |
ブラウザから http://IPアドレス:4567にアクセスするとフロント画面が表示されます。
API Blueprintもいいですが、こちらもなかなかレイアウトがしかっりしててよさげです。

静的ファイルの生成はbuildコマンドで行います。
1 |
bundle exec middleman build |
buildフォルダが作成されて、中に静的ファイルが生成されます。

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


-
前の記事
コマンドプロンプトの背景と文字の色をコマンドで変更する 2020.07.17
-
次の記事
Macでtreeコマンドを実行する手順 2020.07.17
コメントを書く