ドキュメント開発

このドキュメントはmdBookを利用してGitHub Pagesの内容が生成されています。mdBookの詳細な使用方法に関しては、mdBook Documentationを参照してください。また、ドキュメント生成の際には以下のツールが必要です。

画像の使用に関して

ドキュメント内では画像を使用することができます。docs/assetsフォルダー内に使用したい画像ファイルを置き、ドキュメントのMarkdownファイルからその画像ファイルへの相対パスを用いて参照することができます。コミットb66c64aなどを記述例として参照してください。

SNS等に画像をアップロードする場合とは異なり、gitリポジトリでは Exif情報がそのままになっています。 exiftoolやImageMagickなどを用いて適切な処理を施したものを使用してください。

参照: exif情報をコマンド一発で削除する #exif - Qiita, ImageMagickでメタデータから不要な情報を削除する｜e

Google Driveの画像を使用する場合

Google Driveに保存されている画像ファイルはGoogle Driveの画像をMarkdownで直接表示したい時に読む記事などで示される方法に従って参照することができます。しかしこの方法ではGitHub Pages上で画像が表示されない(#99)ため、一工夫加える必要があります。具体的には、以下の手順に従ってください。

1: 使用したい画像のリンクと名前を控える

ここでは画像のリンクをhttps://drive.google.com/uc?export=view&id=xxx, Google Driveに保存してある画像の名前をxxx.jpegとします。

2: 控えた情報をスクリプトに追記する

docs/scripts/fetch-gdrive-assets.bashのpython3 ./docs/scripts/curl-parallel.py docs/gdrive << 'EOF'とある行の次などに以下の内容を追記します。

python3 ./docs/scripts/curl-parallel.py docs/gdrive << 'EOF'
...
https://drive.google.com/uc?export=view&id=xxx xxx.jpeg
...
EOF

適当な場所に追記してください。

3: Markdownで画像を参照する

先ほどbashファイルに追記したことで、mdBookのビルド時に目的の画像がdocs/gdrive/xxx.jpegに配置されるようになります。Markdownファイルでは相対パスで、以下のように記述することで画像を参照可能です。

![](./gdrive/xxx.jpeg)

こちらもSNS等とは異なり、Google DriveはExif情報を編集しません。