メインコンテンツまでスキップ
probot-auto-merge[bot]が最終更新

ステップ3. ページ追加

docsフォルダの中の、該当する場所に .md の拡張子でファイルを作ってください。

#

---title: タイトル---
この記事はうんたらかんたらです。
## 詳しい解説1
あああ
## 詳しい解説2
いいい

ファイルは半角英数字#

ページのURLに影響するので、できれば半角英数字を使ってください。

また、?.をつけないでください。

ウマ娘などの扱いを検討中

日本語のキャラ名って大抵英語で書けるんですが、めちゃくちゃ長くなるんですよ。matikane-tannhauser.mdとか。

タイトルや説明文を設定する#

Markdownの中に「Front Matter」という部分を作ります。

いろいろな書き方がありますが、DocusaurusではYAMLを使います。

例えば、


---title: "これがタイトル"sidebar_label: "サイドバーに表示されるラベル"description: "これは説明"---

これがYAML形式のFront Matterです。

タイトルについて#

warning

Markdownのファイル名をタイトルにしないでください。 タイトルは別途設定し、ファイル名とは分けて考えます。


---title: これがタイトル---

引用符はほとんどの場合必要ありませんが、タイトル中に:がある場合は引用符を使ってください。

引用符が必要な例#


---title: "究極の疑問: うどんはおかずか?"---

見出しを書く#

見出しを作ることは、わかりやすいページ作りの第一歩です。

さて、先ほど「タイトル」を設定しました。これも「見出し」です。サイト上で、ページタイトルは<h1>で囲まれます。

つまり、記事の本文で「第一見出し」を書いてはいけません。最初に「##」の「第二見出し」から始めましょう。

本文を書く#

Markdownガイドを読んでください。