クイックスタート

FAKE.GitBookを使うことで、FSharp.Formattingスタイルで書いたドキュメントをGitBookで出力できます。

依存関係のインストール

Paketを使ってFAKEとFAKE.GitBookをインストールする例を示します。

プロジェクトのルートにpaket.dependenciesファイルを作成し、依存関係を定義してください。 npmをインストールしていない場合は、Npm.jsを依存関係に追加する必要があります。

source https://api.nuget.org/v3/index.json
source https://nuget.org/api/v2

nuget FAKE
nuget FAKE.GitBook
nuget Npm.js // if you don't install npm

Paket - Getting Startedを参考に、依存関係をインストールしてください。

pakage.json

プロジェクトのルートにpackage.jsonを作成してください。

{
  "name": "sample-book",
  "private": true,
  "version": "1.0.0",
  "description": "gitbook sample",
  "scripts": {
    "prepublish": "gitbook install"
  },
  "devDependencies": {
    "gitbook-cli": "^1.0.0",
    "gitbook-plugin-include-codeblock": "^1.5.0",
    "gitbook-plugin-japanese-support": "0.0.1"
  }
}

ビルドスクリプト

まず、ライブラリをロードします。

#r @"packages/FAKE/tools/FakeLib.dll"
#I "packages/FSharp.Formatting/lib/net40"
#I "packages/FSharp.Compiler.Service/lib/net40"
#I "packages/FSharpVSPowerTools.Core/lib/net45"
#r @"packages/FAKE.GitBook/lib/net451/Fake.GitBook.dll"

ターゲットを定義します。

open Fake

Target "Generate" (fun _ ->
  GitBook id id [Html]
)

RunTargetOrDefault "Generate"

book.json

gitbookディレクトリにbook.jsonファイルを作成してください。

{
  "structure": {
    "readme": "INTRODUCTION.md",
    "summary": "SUMMARY.md"
  },
  "plugins": [
    "include-codeblock",
    "japanese-support"
  ]
}

ドキュメントの作成

FSharp.Formattingスタイルでドキュメントを書いてください。

実行

次のコマンドを実行してください。

packages\FAKE\tools\Fake.exe build.fsx

サンプルプロジェクト

FAKE.GitBook.Sampleを参考にしてください。