Appearance
Markdown超入門
この記事では、このドキュメントを書くのに必要不可欠なMarkdownという言語の書き方を紹介したいと思います。
言語、と言いましたが基本はWordなどで書く文章と同じです。
これ(↓, 英文)見てって言えば一発なのですが読解がめんどいので、分かりやすく日本語で説明します。
https://github.github.com/gfm/
見出しの作り方
身出しは、
md
# h1
## h2
### h3
#### h4と書くと、
h1
h2
h3
h4
となるように作ることができます。
なお、Markdownのルールとしてh1の段落(#で作れる)は1つの記事に対して1つにするようにしろよ、というものがあるので守るようにしてください。(守らないと記事のタイトルが生成されません。)
段落の作り方
段落は、
md
ほげほげ
あああ
わぁ!が、
ほげほげ
あああ
わぁ!
となるように一行開けるだけで段落ができます。
因みに、
md
ほげほげ
あああ
わぁ!みたいに改行をしないと、
ほげほげ あああ わぁ!
みたいに一続きになります。
リンクの作り方
[<リンクのラベル>](<URL>)という書き方でリンクを貼ることができます。
画像の貼り方
という書き方で画像を貼ることができます。
リンクを付けたい場合は、](<リンクのURL>)という書き方で付けられます。
文字を強調する
文字を強調したい場合は、**<強調したい文章>**というように*1つで囲みます。
前後に半角スペースを入れる又は改行をしないと、強調されないので注意してください。
因みに、 <強調したい文章> という感じになります。
文字をイタリックにする
文字をイタリック(斜めの筆記体みたいなやつ)にしたい場合は、*<イタリックにしたい文章>*のように_(アンダーバー)1つで囲みます。
前後に半角スペースを入れる又は改行をしないと、イタリックにならないので注意してください。
因みに、 <イタリックにしたい文章> のようになります。
取り消し線をつける
文字に取り消し線をつけたい場合は、~~<取り消し線をつけたい文章>~~のように~(チルダ)2つで囲みます。
前後に半角スペースを入れる又は改行をしないと、強調されないので注意してください。
因みに、 <取り消し線をつけたい文章> のようになります。
コードブロックの作り方
コードブロックとは、
js
module.exports = {
lang: "ja",
title: "Game Docs",
description: "Game Docs of Novel2aGame",
head: head,
themeConfig: {
repo: "Novel2aGame/Docs",
editLinks: true,
editLinkText: "このページをGitHubで編集",
editLink: {
pattern: "https://github.com/Novel2aGame/Docs/edit/main/docs/:path",
},
docsDir: "docs",
docsBranch: "main",
sidebar: articles,
}
}みたいな他の文章とちょっと違う雰囲気を出したいときに便利なブロックです。
これは、
plaintext
```js
module.exports = {
lang: "ja",
title: "Game Docs",
description: "Game Docs of Novel2aGame",
head: head,
themeConfig: {
repo: "Novel2aGame/Docs",
editLinks: true,
editLinkText: "このページをGitHubで編集",
editLink: {
pattern: "https://github.com/Novel2aGame/Docs/edit/main/docs/:path",
},
docsDir: "docs",
docsBranch: "main",
sidebar: articles,
}
}
```という風に表現できます。