このWebサイトの編集方法
このWebサイトはオープンソースでGitHub上に公開されています。ぜひ、タイポの訂正やコンテンツなどの追加にご協力ください
各ページに出ている Edit page
をクリックするとGitHubが開き、編集ができます。そこで訂正し、Pull Requestを送ってください
ページをローカルに落としてプレビューをすると思った通りにコンテンツが生成されているか確認できます。ここではその方法をある程度紹介します。前提として、GitとHugoがインストール済みである必要があります。
また、大幅にコンテンツの書き換え、追加を行う場合は事前にDiscordでコンセンサスを取り、その後詳細をGitHubのIssueを立てるのが好ましいです。
ここでは、Gitの操作方法、PullRequestの送信方法などについては説明しませんので、各々で調べていただきますようお願いします。
リポジトリをクローン後、レポジトリ内で以下のコマンドを実行すると、ライブプレビュー用のWebサーバが立ち上がります。
hugo server -D
記事を追加する場合は、下記のコマンドを実行し、生成されたファイルを編集してください。
hugo new content/hogehoge/foo.md
また、記事に画像を追加する場合は、static/images
配下に配置してください
---
title: "タイトル"
weight: 900
---
ここにコンテンツを入れる
画像は以下のように追加します
![](/images/hogehoge.png)
また、CSSの変更をしたい場合、static/custom.css
に記述します。
また、レイアウトの変更をしたい場合、themes/hugo-gee-doc/layouts
配下のファイルから、レイアウトを変更したい部位があるHTMLファイルを特定します。その後layouts
配下にそれらを同じようにコピーし、コピーしたものを編集してください(themes
配下は基本的に触ってはいけません)
このWebサイトはHugoのテーマの一つである、Geekdocsというテーマを用いています。詳細はGeekdocsのドキュメントを参考にしてください
編集を加え、プッシュした後は、GitHub上でPRを送ってください。PRにレスがない場合、Discord等で間瀬BBまで催促していただけるとありがたいです。