メインコンテンツまでスキップ

202407

blog と site をまとめてサイト管理に。

  • VRM-1.0 を UniVRM-1.0 に変更。一部 VRM 下に移動。
  • VRM Animation を VRM 下に移動。
  • VRM-1.0 の SpringBone の記事

英語版のURLについて

2024-01-15 からサイト更新作業を実施しました。

英語版の url 変更によりリンク切れが発生しました。 url を維持するようにデプロイ方法を変更しました。 現在、元の url でアクセスできるはずです。

vrm.dev.en

英語版の記事を

https://github.com/vrm-c/vrm.dev.en

で管理して、

https://vrm-c.github.io/vrm.dev.en/

にデプロイしていましたが、 デプロイ先を

https://vrm.dev/en/

に修正しました。

不具合は

https://github.com/vrm-c/vrm.dev/issues

にお知らせください。

サイトを更新しました

2024-01-15 からサイト更新作業をしています。

不具合は

https://github.com/vrm-c/vrm.dev/issues

にお知らせください。

sphinx to docusaurus

Document ツールを sphinx から docusaurus に変更しました。

https://github.com/vrm-c/vrm.dev/issues/315

updated: 2024-01-15

  • sphinx toc 記事の順番を復旧
  • sphinx figure(スクリーンショットなど)復旧
  • sphinx admonition(info, warning...)復旧

updated: 2024-01-16

対応アプリケーションの一覧を更新しました。

showcase

登録方法は こちら です。 PullReq じゃなくても issue で受け付けております。 以前に登録済みの方の文言変更などもどうぞ。

updated: 2024-01-17

sphinx から docusaurus への変更に付随する作業はこれで完了の予定です。

updated: 2024-01-19

  • tailingSlash 設定(URL 互換性の修正)

サイト構成

documents

sphinx の markdown を引き継ぎ

先代の sphinx 、その前の hugo の markdown 記事をそのまま引き継いでいます。

/docs/**/*.md

pages

/

React

/src/pages/index.ts

/showcase/

VRM 対応アプリケーション

React

/src/pages/showcase/index.tsx /src/data/tags.tsx /src/data/users.tsx

customize

言語切り替えメニューを改造しています。

Swizzling | Docusaurus

https://github.com/vrm-c/vrm.dev/blob/master/src/theme/NavbarItem/LocaleDropdownNavbarItem/index.js

meta

備考

英訳も確認すること。

title

hard coding

  • /src/pages/index.tsx
`${metaTitle} | ${config.title} `;
  • /docusaurus.config.ts

との組合せ(template)

description

hard coding

  • /src/pages/index.tsx

image

https://docusaurus.io/docs/api/themes/configuration#meta-image

docusaurus.config.js
epport default {
themeConfig: {
image: 'img/docusaurus.png',
}
}

翻訳

言語ごとに 別の docusaurus リポジトリを個別に運営しています。 日本語を原本として、英語版を fork しています。

日本語

https://github.com/vrm-c/vrm.dev

日本語を原本サイトとして https://vrm.dev にデプロイします。

英語

https://github.com/vrm-c/vrm.dev.en

英語版を https://vrm.dev/en にデプロイします。

github-action でまとめてビルド

日本語サイトをビルド時に /en ディレクトリにビルドしています。

英語版の反映方法

英語版を merge した 次回の日本語版 の github action でビルドされます。 即座に反映したい場合は、日本語版の reposity の Actions - Docusaurus - Run workflow ボタンを 手動で押してください(緑のボタン)。

action

翻訳手順

  • vrm.dev の内容が更新される
  • vrm.dev の更新を vrm.dev.en に反映する(fetch merge して push する)。この作業は、vrm.dev の管理者が定期的(毎週?)に実行します
    • 未訳部分が増えます
    • conflict する場合があるが、docusaurus のビルドが通る場合は そのまま commit してよい。TODO: 自動化
  • vrm.dev.en に未訳部分を英訳したり、英文の更新 PullReq を送る

作業例(github の website 上)

TODO: markdown ひとつだけならこれでもできるはず。

作業例(ローカル)

preview を起動

$ git clone https://github.com/vrm-c/vrm.dev.en.git
$ git switch -c fix/EN_TOPIC # 適当な重複しない branch 名をつけてください
$ cd vrm.dev.en
$ npm install
$ npm run dev

# https://localhost:3000 にアクセス。翻訳記事を見る。

エディターで翻訳

push して pull request

作業例(管理者向け。日本語への追随)

TODO: bot で自動化

$ git clone https://github.com/vrm-c/vrm.dev.en.git
$ cd vrm.dev.en
$ git remote add ja https://github.com/vrm-c/vrm.dev

$ git switch -c merge/topic
$ git fetch ja master
$ git merge ja master
$ npm run build

# エラーがある場合は conflict を解決してビルドを通す。
# build が透る場合は merge を commit して先に進めてよい。

$ git commit
$ git push