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

編集者用ガイド

概要​

本サイトはMarkdown形式で執筆します。共同編集にあたっての基本的な記法と、Wiki特有のリンク設定について解説します。
よくわからなかったら、ChatGPTかGeminiに「Docusaurusで以下のページを作りたい。[改行]記事の内容」と書けば大体教えてくれます。
ミスると、サイト全体がクラッシュすることがありますが、全く気にしなくてよいです。巻き戻しが簡単にできるので、最悪こちらで直せます。
docs以外はあんまり触らないでください。

大切なこと

可能な限り引用をつけるようにしてください。
YouTubeやTwitterはもちろん、自分の投稿でも歓迎です。

編集可能な人​

管理者のKYU(Twitter)から招待された人はページ下部の「このページを編集」から編集が可能です(gitが分かるならcloneしていただくのを推奨)。
それ以外の場合でも、GitHubからpull requestを送っていただければ、こちらで精査したうえで追加、編集が可能です。
pull requestがよく分からない場合はissuesに書き込んでいただければ、編集権限を持った人が暇な時に対応いたします。

注意

みんな忙しいので、ずっと追加されないからといって恨まないでください。

基本的なMarkdown​

標準的なMarkdown記法(# で見出し、* で箇条書きなど)がすべて使用可能です。
たとえば、右のメニューに表示したり、アンカーリンクをつけたりしたい場合は##から始めてください。
改行をしたい場合は、改行を2回連続で入れる(段落)か、文末に半角スペースを2回連続で入れてください。

新規ページの作り方​

  • docsディレクトリ内に、mdファイルを作成。
  • ファイルのトップに以下を入力。
---
sidebar_position: 2
title: 自作のお家
---
  • "sidebar_position"は左ペインのどこに表示するか。数字が小さい方が上に表示される。
  • "title"は左ペインに表示するラベル名。
  • docsの中にディレクトリを作って、まとめたい場合は、別途"category.json"が必要(既存の見れば分かると思います)。

ページ内リンク​

特定のセクション（見出し）に直接リンクを貼る方法は以下の通りです。

1. 自動生成されたIDへリンクする​

見出しの文字列から自動的にIDを作成します。

  • 書き方: [ジャンプ先のテキスト](#見出しの文字列)
  • 例: [種族値の詳細へ](#種族値)
  • 例: [このページのページ内リンクの項目に](ページ内リンク → このページのページ内リンクの項目に
    ※スペースは - に、英大文字は小文字に変換されます。

2. カスタムIDを指定する (推奨)​

見出しの文言を変更してもリンクが切れないよう、見出しに独自のIDを付与することを推奨します。

  • 書き方: ## 見出しの名前 {#custom-id}
  • リンク方法: [テキスト](#custom-id)
  • 利点: 見出しを「種族値（第9世代）」に書き換えても、IDが {#stats} であればリンクは維持されます。

3. 別ページの見出しへリンクする​

  • 書き方: [テキスト](/docsからのパス#ID)
  • 例: [ピカチュウの技一覧](/pokemon/pikachu#waza-list)

画像​

/static/imgに保存が可能です。

Twitterの埋め込み​

画像をページに直接貼るのではなく、Twitterを埋め込んでいただくのは大歓迎です。

  • ポストのURLから～～/status/0123456...の数字部分をコピー。
  • <Twitter tweetId="0123456..." />と貼り付けることで、ツイートが表示されます(最初大文字)。
引用欄の使用

記事内だと邪魔な場合は、後述の脚注をご利用ください。
投稿内の画像が必要な場合は埋め込み、そうでない場合は引用がお勧めです。

例:

最高効率の家[^1]  
[^1]: KYU [Twitter@kyuphd](https://x.com/kyuphd/status/2033145701501485146)

便利なコンポーネント​

注釈・警告（Admonitions）​

重要な注意書きには以下の記法を使ってください。

:::tip[執筆のヒント]
補足などは、この緑色の枠を使うと読みやすくなります。
執筆のヒント

補足などは、この緑色の枠を使うと読みやすくなります。

:::danger[検証が不十分]
仮説や検証が不十分のデータにはこの赤い枠を使用し、注意を促してください。
:::
検証が不十分

仮説や検証が不十分のデータにはこの赤い枠を使用し、注意を促してください。

※ note, tip, info, warning, dangerが使えます。

脚注​

本文中に注釈を入れたい場合に使用します。

  • 書き方 本文: 本文です[^1]
  • 書き方 フッター: [^1]: ここに注釈の内容を書きます。
  • 表示: ページ下部に自動的に注釈リスト1が生成されます。

Footnotes​

  1. ここに注釈の内容を書きます。 ↩