Skip to content

Latest commit

 

History

History
73 lines (48 loc) · 2.21 KB

README.md

File metadata and controls

73 lines (48 loc) · 2.21 KB

Kotlin introduction

Kotlin 導入のための資料です。
GitHub pages を使ってホスティングしています。
https://access-company.github.io/kotlin_intro/

注意

Public リポジトリなので社内の情報をコミットしないでください。

ドキュメントのビルド方法

Minimum

必要なツール

  • npm
  • HonKit
    • npm install -g honkit
  • GitBook各種プラグイン

ビルド方法

  • リポジトリをクローンします。
  • トップディレクトリにて、以下のコマンドを実行します。
$ make
  • ドキュメントが docs ディレクトリに生成されます。
  • 参照する場合は、docs ディレクトリを何らかの形でホスティングしてください。

おすすめ(Docker利用)

必要なツール

  1. Docker Desktop
  2. VSCode
  3. Remote Containers
  4. docker-sync via gem install docker-syncRubyも必要)

ビルド準備

  1. VSCodeでkotlin_introフォルダを開く
  2. VSCodeのターミナル→新しいターミナル
  3. docker-sync start
  4. VSCodeの左下端をタップ
  5. Reopen in Containerを選択

ビルド方法

  1. Dockerコンテナ内でmakeを実行

ドキュメントがDockerコンテナ内のdocsに生成され、ホスト側にもsyncされます。

プレビュー方法

  1. Dockerコンテナ内でhttp-server docsを実行
  2. http://localhost:8080/ をブラウザで開く

トラブルシューティング

Error: Couldn't locate plugins "codeblock-filename", Run 'gitbook install' to install plugins from registry.

と出力された場合、npm経由でプラグインをインストールしてください。

npm i -g gitbook-plugin-codeblock-filename