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

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します。

slateプロジェクト作成

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

まずは移動します。

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

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

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

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

「Gemfile」編集

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

slate起動

slateを起動します。

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

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

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

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