KNX

DALI/KNXやIoT系の学習コンテンツ作成にHonKitを使ったテキスト教材がかなり便利そう

DALIやKNX,IoT系のトレーニングを開催していますが、これまでは講義のテキストにMS-WordやPowerPointを使っていました。

でも、Tanaka Seigo(@1ft_seabass)さんからHonKitが便利と教えていただき、環境構築方法も教えてもらったので、あらためてその使い方をメモしておきます。

HonKitの設定については、↓ こちらの記事を見ながら復習しました。

honkit/honkit: HonKit is building beautiful books using Markdown – Fork of GitBook
授業資料やハンズオン資料に使っている HonKit の設定メモ 2022 年 12 月版 – 1ft-seabass.jp.MEMO

事前準備(前提条件)

前提条件

ーgithubのアカウントをもっていること。
ーgithubにssh接続ができること。
ーローカルにgit cloneができること。
ーVisual Studio Codeがインストールされていること

ローカル作業フォルダ作成。

Git レポジトリ作成

seigoさんが作成したhonkitのテンプレートに移動。

1ft-seabass/honkit-base

UntitledImage

create new repositoryで自分のgithubアカウントにレポジトリを作成する。

UntitledImage

honkit-test2というレポジトリを作成。

UntitledImage

自分のMac環境にクローンするための情報をコピーします。

ローカルにgit clone

自分のMacにてTerminalを起動。

HonKit作成用のフォルダに移動し、git cloneといれてから先程コピーしたものをペーストします。

git clone git@github.com:nakachon/honkit-test2.git

作成されたhonkit-test2というフォルダに移動してからVScodeを立ち上げます。

code .
UntitledImage

VScodeが立ち上がったら、Terminalを開きます。

npm i
UntitledImage

ビルドします。

npm run build

ローカル環境でserverを起動します。

npm run serve

これでserverが立ち上がり、localhost:4000を開くと

UntitledImage

ブラウザで表示されます。

github pageで表示させる

UntitledImage

レポジトリの右上にある”Settings”をクリック。

左下にある”Pages”をクリック。

GitHub Pagesの設定がでてくるので、Branchのところを”None”から”main”に変更。

UntitledImage

フォルダはdocsにしてSave。

UntitledImage

しばらくすると、github pageのURLが発行されます。(数分かかります。)

UntitledImage

この時点ではcommitしていないのでクリックしても404になります。

ページを作成

UntitledImage

ドキュメントを作成する場合、SUMMARY.mdが左側に表示される目次になるので、ここにファイル名を記載して、ページをつくっていきます。

UntitledImage

page1.mdを作成。

UntitledImage

summary.mdにリンクを記載。

編集が終わったら

npm run build

git commit and push

UntitledImage

VScodeのGitボタンをクリックして、コメントをいれてコミットをおします。

UntitledImage

はいをクリック。

UntitledImage

変更の同期をします。

これで、git pageにて反映されます。(ちょっと時間がかかる)

UntitledImage

反映されました。

まとめ

技術系チュートリアルのテキストを作成する際、GoogleDocumentやPowerPointなどは、いろんな意味で手間がかかるのでなんとかしたいと思っておりましたが、HonKitを使うことによってそれが改善されそうです。

また、HonKitで作成したテキストを元に、Camtasiaなどで動画を撮影することで、DALIやKNX,IoT系の情報量豊富な学習コンテンツをこれからつくっていきたいと思います。

ABOUT ME
中畑 隆拓
スマートライト㈱ 代表取締役。IoTソリューションの開発、スマートホーム&オフィスのコンサルティング、DALI,KNX,EnOceanなどのインテグレーションを行っています。

COMMENT

メールアドレスが公開されることはありません。 が付いている欄は必須項目です