Skip to content
oyasaiserverPublic

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

おやさいサーバー Wiki

おやさいサーバーのプレイヤー向け Wiki の原稿です。新 Wiki の原稿は src/content/docs/ にあります。platform の oyasai-web と同じ設定・テーマ・依存を使い、このリポジトリからも GitHub Pages に試験公開します。

書き方

GitHub の鉛筆マークから編集するか、ブランチを切って PR を作成してください。新しい配信コンテナの導入後は、main の変更を約5分間隔で確認し、ビルドと検査が成功した版だけを公開します。失敗した場合は前の版を配信し続けます。

フォルダー(src/content/docs/ 以下) ハブ
start/ はじめに・接続
rules/ ルールとマナー
ranks/ ランクと権限
play/ 遊び方・経済
features/ 機能・プラグイン
world/ ワールド・観光・交通
community/ イベント・コミュニティ
staff/ スタッフ・運営

公開をやめたページは、リポジトリ直下の archive/ に移します。ここはビルドの対象外です。

  • 1ページ1テーマ。通常の .md を使用し、冒頭の YAML frontmatter に title を付けます。MDX・シンボリックリンク・submodule は使えません。
  • ページ間リンクは公開 URL(例: [SocialLikes](/features/sociallikes/))で指定します。index.md はそのディレクトリの URL、その他の .md は拡張子を除いた末尾 / の URL になります。
  • サイドバーは自動生成されます。順番は frontmatter の sidebar.order、表示名は sidebar.label で指定します。
  • 画像は外部の HTTPS URL または public/images/ に保存した画像の公開パス(例: /images/seesaa/example.webp)を参照します。
  • Markdown の生 HTML は無効です。frontmatter は title、description、template、pagefind、sidebar(order・label・hidden)、hero(テキスト・リンク・限定されたアイコン)に限定され、HTML・任意の属性やスクリプトは使えません。
  • 原稿の中身に関する事実の確認方法は AGENTS.md を参照してください。

表記の決まり

  • サーバー名は「おやさい鯖」。版は「統合版」「Java版」(BE・PE・JE は使わない)。
  • 呼び方は「運営」「プレイヤー」「いいね」「制作者」(建物・車・コースなどを作った人)。
  • ゲーム内のお金は「円」。本物のお金は必ず「日本円」と書く。
  • ランクは「初級」「中級」「上級」「建築士」。匠は必ず「赤匠」「青匠」「灰匠」と色を付ける。
  • 日本語の文の補足は全角「()」、英数字だけの括弧は半角「()」。
  • ゲーム内の表示文と、過去のイベント告知・歴史の引用は原文のまま残す。

原稿を確認する

python -m venv .venv
.venv/bin/pip install -r requirements-content.txt
.venv/bin/python -m unittest discover -s scripts -p 'test_*.py'
.venv/bin/python scripts/check-content.py

ローカルのサイトビルドには Node.js 22.22.3 を使い、npm ci && npm run build を実行します。 npm test && npm run check:site で base 対応、生成後のリンク・アンカー・画像と日本語検索を確認します。生成物は dist/ に出力されます。 astro.config.mjs の base を消すとルート配信に切り替わり、原稿のリンクを書き換える必要はありません(独自ドメインへ移る際は site も変更します)。

旧 Wiki の image01.seesaawiki.jp・image02.seesaawiki.jp と、許可を得た Discord の cdn.discordapp.com・media.discordapp.net の画像は、node scripts/import-images.mjs で原稿と archive から取り込みます。Node 標準ライブラリと cwebp が必要です。PNG・JPEG は cwebp -q 85 -m 6 で WebP に変換し、大きくなる場合は元形式を保存します。GIF・WebP は変換しません。先頭バイトを検査し、10 MB を超える画像は保存しません。対応表と失敗 URL は scripts/images.json に記録し、失敗した参照は外部 URL のまま残します。ビルド後の node scripts/check-images.mjs で参照と保存画像を検査できます。

PR の CI は原稿の YAML・タイトル・内部ページリンクに加え、サイトをビルドして Starlight の schema、生成後のリンクと日本語検索を検査します。PR では公開せず、main への push または main での手動実行で検査に成功したサイトを GitHub Pages(https://oyasaiserver.github.io/wiki/)へ公開します。

旧 docs/、mkdocs.yml、requirements.txt は移行中の参照として残しています。新 Wiki の原稿は src/content/docs/ を編集してください。旧 MkDocs の CI ビルドは原稿検査へ切り替えています。

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages