コンテンツにスキップ

このポートフォリオの工夫

エンジン開発ではドキュメンテーション作成も重要であると考えていたため、
1年以上、Markdownを用いたドキュメンテーション作成について研究してきました。

じつは、このポートフォリオ自体が、その研究の成果でもあります。

バージョン管理

いつ、どんな作業をしたかが分かるようにGitHubでバージョン管理をしています。
リポジトリ:https://github.com/mewmew-tea/Portfolio

MarkdownからHTML生成

「MkDocs」を用いて、MarkdownからHTMLファイルを生成しています。

私は「見やすいドキュメントを高速に書く」という目標のために、
Markdownから文書を作成する手段を研究してきました。

また、当初は、「MkDocs」ではなく、VSCodeの拡張機能「Markdown PDF」のHTML出力機能を使っていました。
しかし、CSSを作成しづらいなど、見やすいレイアウトにすることが困難でした。
そこで、扱いやすいテーマが充実している「MkDocs」を使っています。

自動でデプロイ(CD)

継続的に自動でデプロイするようにしました。
リモートリポジトリへpushしたとき、自動でHTML形式で生成します。

就活で扱いやすくするため、以下の2種類をビルドしています。

  • GitHub PagesのWebサーバー上に配置するバージョン(インターネット上の誰からでも、最新版を閲覧可)
  • ローカルで閲覧するためのバージョン(就活時に作品データと一緒に提出)

アクセス解析(Google Analytics)

私自身をより効果的にアピールできるポートフォリオにするため、Google Analyticsを埋め込んで、アクセス解析をしています。

読みやすさに考慮したデザイン

読みづらいと感じることのないように、配色はカラーユニバーサルデザインに配慮しています。

明度や彩度を意識して色分けしたり、色覚をシミュレーションするスマートフォンアプリで実際に確認をしたりしています。

また、目に優しいダークテーマも用意しました。
ページ右上の「 / 」アイコンをクリックすると、切り替えができます。お好みのテーマをお選びください。