はじめに

この文章ではmdBookで日本語の技術文書を書くためのテンプレートmdbook-ja-templateについて説明します。 このテンプレートを使うことで、 Markdownの文書をHTMLに変換し、ウェブサイトとして公開できます。

特徴

mdbook-ja-templateの特徴を説明します。

すぐに執筆・発信できる

文書執筆に必要なツール一式がDockerコンテナ化されているため、面倒なセットアップ作業は不要です。 すぐに執筆を始めることができます。

文書公開のために必要な作業がGitHub Actionsのワークフローとして定義されており、自動的に実行されます。 余計な手間をかけることなく、作成した文章をすぐに発信できます。

文書校正が自動で行われる

文章校正ツールtextlintが導入されているため、文書の自動校正が可能です。 初期状態で技術文書向けの校正ルールが設定されていますが、自分好みになるようカスタマイズ可能です。

Markdownのスタイルチェックツールmarkdownlintも導入されているため、Markdownの自動スタイルチェックも可能です。

コマンドを覚えなくても使える

文書校正や各種チェックツールはmake check -kを実行するだけで一括実行できるよう設定されているため、各種チェックツールのオプションを覚える必要はありません。 その他にも、執筆時の典型的なタスクがMakefileで実行できるよう設定されています。

コントリビューション

mdbook-ja-templateはオープンソースプロジェクトで、ソースコードはGitHub上で公開されています。 問題の報告や機能追加の要望はGitHubのIssueトラッカーに投稿してください。

ライセンス

mdbook-ja-templateはCreative Commons Zero v1.0 Universalライセンスで配布されています。