Skip to content

utelecon/utelecon.github.io

BranchesTags

Repository files navigation

utelecon (The Portal Site of Information Systems @ UTokyo)

https://utelecon.adm.u-tokyo.ac.jp/

uteleconは，オンライン授業やWeb会議に関する情報をワンストップで得られることを目指して東京大学が開設したウェブサイトです．詳しくはuteleconについてをご覧ください．

Preview

Node.js が必要です．v22の最新版（LTS）をインストールしてください．

  • レポジトリをクローンしたら，まずnpm installを実行します．
  • プレビューを開始するには，npm run devを実行します．^Cで終了します．

Pull Requestのプレビューについて

上記のローカルでのプレビューに加え，utelecon/utelecon.github.ioでPull Requestを作成すると，自動的にNetlify上にプレビューが作成され，編集されたサイトをオンラインで確認することができます．

具体的には，Pull Requestを新しく作成したり，既存のPull Requestのコミットを追加・変更したりしたときに，自動的にプレビューが作成されます．また，自動的に作成されるプレビューが利用できない場合（Dependabotが作成したPull Requestや，最後にプレビューを作成してから時間が経ったPull Request等）は，Pull Requestに/deploy-previewとコメントを送ると，強制的に作成させることができます．

なお，以下のようにいくつか注意点があります：

  • プレビューは，その時点で「もし当該Pull Requestがマージされたとした場合の」状態で作成されます．
    • このため，ブランチが古い場合，ローカルで作成したプレビューとは内容が異なる場合があります．git merge masterを行うとローカルと一致します．
  • コンフリクトのあるPull Requestでは自動的なプレビューの作成は行われません．
    • また，コンフリクトのあるPull Requestで/deploy-previewを使った場合，最後にマージ可能だった時点の状態で作成されます．
  • /deploy-previewはGitHub上の utelecon organizationのメンバーのみ利用できます．

Frontmatter

Markdownファイルのフロントマターにかける設定は以下の通りです：

  • title：ページのタイトル．表示されるタイトルになるほか，<title>要素の中身にもなり，Slack等でリンクを共有した際に表示される．必須．
  • description：ページの説明．Slack等でリンクを共有した際に表示される．
  • h1：ページの表示されるタイトル．titleと異なり，Markdownを含めることができる．
  • toc：falseとすれば，ページの目次を表示しない．
  • sitemap：falseとすれば，サイトマップに含まれない．
  • author：記事の著者をページ下部に表示する．
    • affiliation：所属．authorを指定する場合は必須．oesとするとOESの説明ページへのリンクが表示される．
    • name：著者名．任意．
  • breadcrumb：ページ上部のパンくずリストを定義する．詳しくは後述．
  • redirect_from・redirect_to：リダイレクトの設定．詳しくは後述．

Scripts

  • npm run dev：プレビューを開始する．^Cで終了する．
  • npm run build：ページをビルドし，distに成果物を出力する．
  • npm run find-link：引数で指定したページへのリンクをすべて標準出力する．
    • dist以下のHTMLファイルを読むため，あらかじめnpm run buildしてから実行する．
    • 例：npm run find-link /oc/url
  • npm run broken-link：サイト内リンクで壊れているものをすべて標準出力する．
    • dist以下のHTMLファイルを読むため，あらかじめnpm run buildしてから実行する．
  • npm run unused-asset：使われていないアセットをすべて標準出力する．
    • dist以下のHTMLファイルを読むため，あらかじめnpm run buildしてから実行する．

Navigation

utelecon のナビゲーションは原則として，パス構造をもとにした木構造に基づきます．サイト全体のナビゲーションには主に以下の4つがあります：

  • ヘッダー
    • src/data/nav/{ja,en}.yml の通りに生成されます．
    • hidden: true とあるエントリーは表示されません．
  • フッター
    • src/data/nav/{ja,en}.yml の通りに生成されます．
    • hidden: true とあるエントリーは表示されません．
  • サイトマップ (/sitemap/)
    • src/data/nav/{ja,en}.yml の通りに見出しが生成され，その構造に合わせて全てのページのリンクが表示されます．
    • sitemap: の内容によって挙動が変わります．詳しくは src/data/schemas/nav.json を参照してください．
    • フロントマターに sitemap: false と書いたページは表示されません．
  • パンくずリスト

How it works

Astroという静的サイトジェネレータを用いています．特殊な機能について以下で説明します．

src/pages以下のファイルを公開する

  • 概要
    • src/pages以下のファイルはデフォルトで公開されます．画像等はsrc/pages以下に置いてください．
    • src/pages以下で，_で始まるファイルは公開されません．src/pages以下に置きたいが公開したくないファイルは，名前を_で始めてください．
    • src/pages以下で，MarkdownやMDXなどのHTMLに変換されるファイルは公開されません．
  • 理由
    • 多くのページで，ページのソースとそこに含まれる画像を同じディレクトリに置いて管理しています．これらのページを移行する際に，src/pages以下のファイルをデフォルトで公開することで，画像等のパスを変更する必要がなくなり，またファイルと画像を同じディレクトリに置いたまま管理できます．
      • このような状態になっているのは，移行前のJekyllでルートディレクトリのファイルがデフォルトで公開されていたためです．
    • またsrc/pages以下には，_で始まる公開したくないファイルが多く存在しています．これらの中には近隣の別ファイルで利用されているものがあります．この機能により，関連するファイルを近くのディレクトリに置いたまま管理できます．
      • このような状態になっているのも，Jekyllで_で始まるファイルは公開されなかったためです．
  • 実装
    • デフォルトで公開する機能は，設定ファイルでpublicDir: "src/pages"とすることで実現しています．
    • _で始まるファイルとHTMLに変換されるファイルが公開されない機能は，CleanupIntegration.tsで実現しています．ここでは，ビルド完了後に成果物が格納されるdistフォルダから条件に一致するファイルを削除しています．

Markdownのデフォルトレイアウト

  • 概要
    • src/pages以下のMarkdown/MDXファイルにはデフォルトのレイアウト (@layouts/Layout.astro) が適用されます．
    • _で始まるファイルにはデフォルトのレイアウトは適用されません．
  • 理由
    • すべてのMarkdownファイルのフロントマターでレイアウトを指定するよりも，デフォルトのレイアウトを適用する方が簡潔です．
    • _で始まるファイルは他のファイルに埋め込まれることがあるため，デフォルトのレイアウトを適用すると入れ子になってしまいます．
  • 実装
    • DefaultFrontmatterPlugin.tsで実現しています．Astroでは，レイアウトをMarkdownのフロントマターで指定します．このプラグインはRemarkプラグインで，Markdownのパース時にフロントマターにlayoutを指定または上書きすることで，要件を満たしています．

IAL (Inline Attribute Lists)

  • 概要
    • Markdown/MDX内で，{:#id}，{:.class}, {:attribute="value"}のような記法によって，変換されるHTMLの属性を追加することができます．
    • 元々はKramdownというMarkdown処理系の機能です．
    • 詳しくは後述します．
  • 理由
    • 多くのページで，そのソースに上の記法が使われています．移行にあたり，全てのページでこれを変更するのは非現実的でした．
      • このような状態になっているのは，JekyllでKramdownが利用されていたためです．
    • また，id属性やclass属性を指定するためだけにHTMLを書くのは冗長です．
      • しかも，Astroの見出しの一覧を取得する機能を利用して目次を生成する際，MDXでは見出しがMarkdownの記法で記述されている必要があります．
  • 実装
    • BlockIALPlugin.jsで実現しています．このプラグインはRemarkプラグインで，パーサーを拡張しています．

*を用いた強調の単純化

  • 概要
    • Remarkでは，*や_を用いて太字や斜体を指定する文法が複雑です．例えば文章の**ここだけ**を太字にするというMarkdownは太字にならず，文章の **ここだけ** を太字にするなどとする必要があります．
    • この機能は，そのような複雑な挙動を排し，単純に*や_で囲まれた文字列を太字や斜体にします．
  • 理由
    • 多くのページで，太字や斜体の指定はKramdownの単純な挙動に依存していました．これらを全て修正するのは非現実的でした．
      • このような状態になっているのは，JekyllでKramdownが利用されていたためです．
    • 日本語では単語間の区切りに空白を入れないため，Remarkの記法は不自然です．
  • 実装
    • SimpleAttentionPlugin.jsで実現しています．このプラグインはRemarkプラグインで，パーサーのうちトークナイザーの部分を上書きしています．

リダイレクト

  • 概要
    • Markdownのfrontmatterでredirect_toおよびredirect_fromを指定することで，リダイレクトを実現できます．
    • 詳細は後述します．
  • 理由
    • 歴史的経緯により，元々存在したURLのページが削除され，別のURLのページに誘導すべき場合があります．この場合に，リダイレクトを1つのファイルで中央集権的に管理するよりも，各ページのfrontmatterで管理する方が簡潔です．
    • 多くのページで，リダイレクトの指定はfrontmatterによって行われていました．これらを全て修正するのは非現実的でした．
      • このような状態になっているのは，jekyll-redirect-fromが利用されていたためです．
  • 実装
    • RedirectIntegration.tsで実現しています．ここではAstroのビルド前に，src/pages内のファイルをすべて読んで設定ファイルのredirectsに必要なエントリーを追加することで，Astroにリダイレクトに必要なページを生成させています．

外部リンクの処理

  • 概要
    • 外部リンクには自動でtarget="_blank" rel="noopener noreferrer"が付与されます．
  • 理由
    • 外部リンクは，別タブで開くのが一般的です．
    • すべての外部リンクに対してこの属性を明示的に付与するのは冗長であり，また忘れる可能性も高いため，自動で付与すべきです．
  • 実装
    • Astroのミドルウェア機能を用いてexternalLinks.tsで実現しています．ここでは，レンダリング後のHTMLをdistに保存する前に一度Rehypeでパースし，rehype-external-linksを適用するという動作によりページを処理しています．
    • AstroではMarkdownやMDXの変換に後処理を追加することはできますが，同様にページを生成する.astroファイルの変換を操作する手段は提供されていません．外部リンクはページの様々なところに現れうるため，それらを包括的に処理するべくこのような実装となっています．以前は生成された.htmlファイルを追加で再処理することで実現していました．

URL末尾のスラッシュについて

  • 概要
    • すべてのURLの末尾にスラッシュが付くようになっています．
    • src/pages以下のページファイルで，src/pages/oc/index.mdxやsrc/pages/systems/index.mdなどのindexファイルは，/oc/や/systems/などのindexを除いた/で終わるURLにマップされます．
    • src/pages以下のページファイルで，src/pages/oc/movies.mdxやsrc/pages/systems/wlan.mdなどのindexでないファイルは，/oc/movies/や/systems/wlan/などのファイル名から拡張子を取り除いて/を加えたURLにマップされます．
  • 理由
    • 従来，indexファイルは/で終わるURLに，indexでないファイルは/で終わらないURLにマップされていましたが，複数の問題がありました．
      • ページファイルの配置変更で，/で終わるURLのページが/で終わらないURLのページに変更になった場合にリダイレクトができない．
      • URL末尾の/の扱いがホスティングサービスにより異なるため，ホスティングサービスの変更が困難．
    • そこで，すべてのURLの末尾に統一して/を付けるように変更を行いました．
  • 実装
  • 注意点
    • 非indexページでは，内部リンクの相対パスの起点が1つ上の階層になります．
    • 例：src/pages/aaa/bbb.mdからsrc/pages/aaa/ccc.mdに相対パスで内部リンクを貼る場合
      • ../ccc/とする必要があります．
      • それぞれのページが/aaa/bbb/，/aaa/ccc/というURLパスにマップされるためです．

IAL (Inline Attribute List)

Markdown内で，ある要素に対してHTMLの属性を指定することができます．Kramdownに実装されているものをRemark Pluginとして移植しています．

例：見出しのid属性を指定する

# 見出し
{:#id}

（本文）

例：画像のclass属性を指定する

![uteleconのロゴ](/assets/images/ogp.png){:.medium}

redirect_from / redirect_to

src/pages内のMarkdownのfrontmatterにredirect_from/redirect_toを記述することで，リダイレクトするように設定できます．jekyll-redirect-fromにある機能を移植する形で実装しています．

例：src/pages/docs/byod.mdにredirect_fromを記述し，/notice/byodから/docs/byodにリダイレクトする

---
title: 東京大学のBYOD方針
redirect_from:
  - /notice/byod
---

（ページ内容）

注

  • redirect_fromは文字列または文字列の配列で指定することができる
  • 基本的に/で始まるパスを指定する

例：src/pages/forms/entry_trouble.mdにredirect_toを記述し，/forms/entry_troubleから/oc/join#formにリダイレクトする

---
redirect_to: "/oc/join#form"
---

注

  • redirect_toは文字列で指定することができる
  • 基本的に/で始まるパスを指定する
  • リダイレクト先のページ内の特定の場所（例では#form）に飛ばしたい，外部のページに飛ばしたいなど，特別の事情がなければredirect_fromの方が良い

複数ページに緊急のお知らせを掲載する

src/emergencies内に以下のようなMarkdownファイルを配置することで，複数のページにまとめて緊急のお知らせを掲載することができます．掲載したいページのパスにマッチする正規表現をpatternに指定します．

例：src/emergencies/LmsFailure.mdxを作成して，/utol/以下のページに緊急のお知らせを掲載する

---
pattern: "^\/utol\/"
---

<div class="box">
  UTOLの緊急のお知らせです．
</div>

注

  • patternには正規表現を文字列で指定してください．
  • ^\/utol\/$のようにすると，/utol/のみに緊急のお知らせを掲載できます．
  • 同じページのパスに2つ以上の緊急のお知らせがマッチする場合，ファイル名の辞書順で同時に掲載されます．ファイル名は実際のサイトには表示されないため，適宜変更して問題ありません．

パンくずリストの表示

breadcrumbをMarkdownのfrontmatterに記述することで，ページ上部にパンくずリストを表示することができます．

  • title：パンくずリストのそのページ自身の部分のタイトル．breadcrumbを指定する場合は必須．親との差分だけを書く．
  • parent：親ページ．任意．デフォルトは../．これを辿っていくことでパンくずリストを構成する．

ルート直下のページ（/utokyo_account/，/oc/など）を除き，パンくずリストを表示するには，breadcrumbを記述した上位階層の親ページが必要です．子ページのみにbreadcrumbを記述することはできません．

例：/eccs/以下のページにパンくずリストを表示する場合

  • ルート直下の親ページ/eccs/（src/pages/eccs/index.mdx）

    ---
title: ECCS端末
breadcrumb:
  title: ECCS端末
---
    • ルート直下のページにはパンくずリストが表示されません.
    • ただし,breadcrumbは子ページでパンくずリストを表示するために必須です．

  • 子ページ（parentを指定しない場合）/eccs/support/（src/pages/eccs/support/index.mdx）

    ---
title: 問い合わせ先・窓口
breadcrumb:
  title: 問い合わせ
---
    • parentはデフォルトで../なので，/eccs/が親ページになります．

  • 子ページ（parentを指定することで，/eccs/を親ページにする場合）/eccs/features/printing/（src/pages/eccs/features/printing/index.mdx）

    ---
title: 印刷
breadcrumb:
  title: 印刷
  parent: ../../
---

ボタン・タブUIを利用したい場合

多要素認証の初期設定手順やサポート窓口のページでは，ボタンとタブを用いたUIが利用されており，ユーザの選択によって表示内容を切り替えたり，ボタンをクリックして別のページに遷移したりすることができます．

これらの実装はコンポーネントとしての共通化が困難であるため，ページごとに個別に実装することとなっています．ボタン・タブUIを利用したい場合は，既存の実装を参考に実装いただくか，Slackでご連絡ください．

その他のドキュメント (For developers)

About

utelecon.adm.u-tokyo.ac.jp/

Resources

Readme
Activity
Custom properties

Stars

56 stars

Watchers

12 watching

Forks

39 forks
Report repository

Releases

2 tags

Packages

No packages published

Contributors 109
+ 95 contributors

Languages