技術書を作成するツールなど¶
Python などのプログラミング言語を学べる教材を作成したい。こういった技術書を作成して行くのに最適なツールはあるのだろうか、、、、
今は、Jupyter notebook にセル単位で、マークダウン形式の説明文章とPythonのプログラミングコードを合わせて説明内容を作成している。
プログラミング言語を初学者でもわかるように解説する文章の教材を、紙の書籍1冊分くらいでまとめていきたい。
世の中には次のようなツールがあるようだ、、、、
- 執筆ツール
- Markdown + GitHub/GitLab:シンプルに執筆しつつバージョン管理もできる。
- Scrivener:長文執筆向けのツールで、章構成を整理しやすい。
- Notion:執筆とメモ、タスク管理を一元化できる。
- コード執筆・実行環境
- Jupyter Notebook:Pythonコードと解説を一緒にまとめられる。
- VS Code + Markdown Preview:コードとMarkdownを扱いやすい。
- Google Colab:読者がブラウザで簡単に試せる環境を提供できる。
- 組版・PDF化
- Pandoc:MarkdownからPDF/HTML/EPUBに変換可能。
- LaTeX(Overleaf):本格的な組版が必要なら選択肢になる。
- mdBook:Markdownベースのドキュメント生成ツールで、Web形式の技術書向け。
- 販売・公開方法
- Booth/Fanbox:個人販売向け。
- Amazon Kindle Direct Publishing (KDP):電子書籍化して販売するなら有力。
- 技術書典 or 同人誌即売会:リアルイベントでも販売可能。
- Qiita/Zenn:一部を無料公開し、認知度を上げる戦略も。
過去に、Markdown のマークアップ文章を GitHub のリポジトリにコミットして、さらには Gitbook といったような仕組みを使ってインターネット上にサイト公開を行ったことがある。この構成は、サイトを立ち上げる先がGitHubのホスティングサービスとなるため、Webサイトとしての取り回しには制限がある印象がある。例えば、サイトのPVを取得したり、アフィリエイト広告をつけたりなど、Webサイトとしての機能追加にはいつかは自由が効かなくなる。純粋に技術内容をまとめた静的サイトだけが必要な場合は有用だが、将来的には、サイトとしての運営に踏み込んだ使い方をしたい。
Scrivener は初めて知ったがどんなツールだろうか、、、、
Scrivenerの概要¶
Scrivener(スクリブナー)は、長文執筆向けのライティングソフトで、特に小説、論文、脚本、技術書などを書くのに適したツールです。
基本情報¶
- 提供者:Literature & Latte社(イギリスのソフトウェア会社)
- リリース時期:2007年(Mac版) → 2011年(Windows版)
- 価格:有料(買い切り型)
- Mac/Windows版:約$59(日本円で約8,000円前後)
- iOS版:約$19.99(約3,000円前後)
- 対応OS:Windows / macOS / iOS
- 無料版:トライアル版あり(30日間の使用日数カウント方式)
Python技術書執筆に向いている?¶
向いている点:
- ✔ 構成を整理しながら書きやすい。
- ✔ 各章を独立して管理できる。
- ✔ PDFやePub、Markdownに簡単に書き出せる。
向いていない点:
- ❌ コードを書くのには向かない(エディタ機能は貧弱)。
- ❌ Jupyter Notebookのように実行結果をそのまま表示できない。
- ❌ チームでの共同執筆にはあまり向いていない。
執筆ツールっぽいが、プログラミングコードが含まれるような技術書には向いていないのかもしれない、、、、
Notion は最近よく聞くが、WordPress のようなブログを作成できるものでサービスとして提供されているので、サーバ構築などが不要ですぐにでも記事を執筆できるような印象がある。こちらもブログ記事を作成するには、WordPress同等の機能を持っていると思われるが、プログラミングコードを書くにはどうだろうか?求めるのは、記事内容の執筆は、マークダウンや LateX で記述できて、それをNotionやGitHubといったホスティングされている場所に投稿するだけでWebサイトとしてインターネット公開でき、さらには必要に応じて収益化の設定やマークアップよりさらに高尚なサイトのカスタマイズまでできる機能を程よく備えている仕組みがあったりしないものか、、、、
MarkdownファイルやHTMLファイルを投稿するだけでWebサイトとして公開できる仕組みはいくつかあるようです。
1. GitHub Pages + MkDocs(or Jekyll) ✅¶
📌 特徴
- MarkdownファイルをそのままWebサイト化できる
- GitHubリポジトリにMarkdownをアップロードするだけ
- 技術文書向けなら「MkDocs」、ブログ形式なら「Jekyll」が便利
2. Hugo + GitHub Pages(or Netlify) ✅¶
📌 特徴
- 超高速な静的サイトジェネレーター
- Markdownを使って技術ブログやドキュメントを作成
- テーマが豊富(特に技術系向け)
- GitHubにMarkdownをアップするだけでWebサイト化
3. Zenn.dev や Qiita に投稿する(簡単な方法) ✅¶
📌 特徴
- Markdownを書くだけで簡単に技術記事を公開
- Zennでは「Zenn CLI」を使うとローカルで執筆→アップロード可能
- 公式サイトにホスティングしてもらえるので、サーバー管理不要
4. Docusaurus + Vercel(or Netlify) ✅¶
📌 特徴
- Facebook製の静的サイトジェネレーター
- Markdownベースの技術文書向け
- Reactでカスタマイズ可能で、見た目が美しい
- Vercel/Netlifyと組み合わせると無料でデプロイ可能
ツール | 難易度 | 特徴 | おすすめ用途 |
---|---|---|---|
MkDocs | ⭐⭐ | シンプル、技術書向け | 技術ドキュメント作成 |
Hugo | ⭐⭐⭐ | 高速&カスタマイズ性◎ | 技術ブログ+ドキュメント |
Zenn/Qiita | ⭐ | すぐ公開できる | とにかく手軽に発信 |
Docusaurus | ⭐⭐⭐⭐ | デザイン性◎、React対応 | 公式ドキュメント風のサイト |
✅ 結論1¶
- 技術書のWeb版を作るなら → MkDocs or Docusaurus
- 技術ブログも書くなら → Hugo
- 簡単に記事を書きたいなら → ZennやQiita
軽量マークアップで執筆することでWebサイトを構築できるサービスは把握できた。そうやって作ったサイトにアフィリエイトなどを設定できるのだろうか?
GitHub Pages + Google AdSense(無料) ✅¶
📌 特徴
- 無料でMarkdown/HTMLをホスティング可能(GitHubにアップロードするだけ)
- アフィリエイト(Amazonアソシエイト、楽天アフィリ、ASP系)のリンク設置OK
- Google AdSenseはJavaScript制限により使いにくいが、回避策あり
🛠 Google AdSenseを使う方法
GitHub Pagesは「広告を直接埋め込めない」制約があるが、次の回避策で対応可能:
- Cloudflare Workersを使って広告スクリプトを挿入する
- JekyllやHugoで動的にAdSenseコードを埋め込む
📌 技術ブログや技術書公開サイトならGitHub Pages+アフィリでOK。AdSenseは工夫が必要!
そのほかのツール
ホスティング | 費用 | アフィリエイト | Google AdSense | 特徴 |
---|---|---|---|---|
GitHub Pages | 無料 | OK | 工夫すれば可能 | 静的サイト向け、無料で運営可 |
Netlify | 無料プランあり | OK | OK | GitHub連携が簡単、技術ブログ向け |
Vercel | 無料プランあり | OK | OK | Next.js対応、技術書+ブログ向け |
WordPress | 有料(月500円~) | OK | OK | 高機能、アフィリ最適だが維持費あり |
Zenn / Qiita | 無料 | 一部OK | 不可 | 記事投稿型、アフィリは制限あり |
🎯 結論2¶
- 技術書を無料で公開しつつアフィリするなら → GitHub Pages + Amazonアソシエイト
- 本格的に収益化するなら → Netlify or Vercel + AdSense
- アフィリ特化のブログにするなら → WordPress
どうやら、Git Pages でアフィリエイトもできそうですね!