Mordhau Guides 1.0.0 を公開しました — ガイドは安定版となり、修正提案もいつでも歓迎します。

Skip to content

Markdownとは

Markdown は、シンプルかつ効率的な方法でテキストをフォーマットするために使用される軽量のマークアップ言語です。これは、プレーン テキスト ドキュメントを視覚的に魅力的にし、HTML などの構造化フォーマットに簡単に変換できるようにすることを目的として、John Gruber と Aaron Swartz によって 2004 年に作成されました。Markdown は、GitHub のようなドキュメント、ブログ、電子メール、コード リポジトリで広く使用されています。

このマークアップ言語は、ゲーム Mordhau、その開発、またはその MOD の作成とは何の関係もありません。それは単に独立して存在し、さまざまな領域にわたって複数の用途がある知識の分野です。私たちがここでそれを説明しているのは、あなたがこのページを読んでいるゲーム Mordhau のドキュメントに貢献するためにそれを使用しているという理由だけです。

INFO

プログラミングや Web サイトに詳しくない方向けの情報:
HTML はマークアップ言語でもあり、すべての Web サイトの基本構造です。Mordhau ドキュメントに貢献することのみを目的とする場合、このページについて学習したり理解したりする必要はありません。Markdown を学習するだけで済み、最終的には HTML コードに変換されます。

私たちは、プログラミングの複雑さを説明したり、技術的な詳細が満載の世界にあなたを引き込むことを目的としていません。私たちの唯一の目的は、Mordhau ドキュメントへの貢献のみに焦点を当てることです。あなたがプログラミング言語の初心者であっても、プログラミング言語の知識がまったくなくても、私たちはできる限り物事を簡素化し、貢献への道を容易にするよう努めています。

Markdown はどこで使用されますか?

Markdown は、そのシンプルさと汎用性により、さまざまなコンテキストで使用されます。Markdown が適用される一般的な領域をいくつか示します。

  1. 技術ドキュメント:
    Markdown は、GitHub、GitLab、Bitbucket などのリポジトリに README ファイルを記述するために広く使用されています。
  2. ブログ プラットフォーム:
    Medium や Jekyll などの多くのプラットフォームは、整形式の投稿を簡単に作成するために Markdown をサポートしています。
  3. コンテンツ管理システム (CMS):
    Markdown は、Hugo や Gatsby などの静的サイト ジェネレーターでよく使用されます。
  4. 電子メールとメッセージング:
    Markdown は、特に Slack や Discord などのツールで、クリーンでプロフェッショナルな電子メールやチャット メッセージの書式設定に役立ちます。
  5. メモ作成アプリケーション:
    Notion、Obsidian、Evernote などの人気ツールは、メモを効率的に整理するために Markdown をサポートしています。
  6. 教育プラットフォーム:
    Markdown は、すっきりとした構造化された情報を提示するために Wiki やチュートリアルで使用されます。

Markdown はどのように機能しますか?

Markdown は、特殊文字を含むプレーン テキスト構文を使用して書式設定を定義します。以下にいくつかの例を示します。

1- 見出し:

md
# Heading 1

## Heading 2

### Heading 3

見出しは、1 ~ 6 文字の # 文字で始まる行です。1 つの # はページ タイトル、## はセクション、### はサブセクションです。その後に空行を入れてください。

2- 強調:

md
*italic* or _italic_
**bold** or __bold__
***bold italic***
~~struck through~~

3- リスト:

md
- first item
- second item
  - a nested item, indented by two spaces

1. numbered
2. list
3. of things

番号付きリストは自動的に番号を付け直すため、各行に 1. と記述しても、Markdown は正しくカウントされます。

md
[text people click](https://example.com)

5- 画像:

md
![description of the image](/path/to/image.webp)

角括弧内の説明は、スクリーン リーダーが通知する内容と、画像の読み込みに失敗した場合に表示する内容なので、そこに実際の内容を記述します。

6- コード:

いくつかの単語を 1 つのバッククォートで囲んでコードとしてマークします。これは、ファイル名、コマンド、構成キーに役立ちます。それ以上の場合は、3 つのバッククォートを使用して言語に名前を付けます。

md
```bash
ノード -v
```

7- 引用:

md
> Anything after a > is a quote block.

8- テーブル:

md
| Setting | Meaning |
| --- | --- |
| MaxSlots | How many players fit on the server |
| ServerName | The name shown in the browser |

2 行目のダッシュは、それを表に変えるものです。列はソース内で一直線に並んでいる必要はありません。

Markdown がしないこと

Markdown には、色、フォント、テキストの配置、レイアウトに関する構文が意図的にありません。それが重要です。ドキュメントはその構造を説明し、サイトが構造の見た目を決定します。それと戦っていることに気付いた場合は、通常、代わりにテーマが処理すべき何かを行おうとしています。

上記の構文は標準の Markdown であり、どこでも機能します。このサイトには、コールアウト ボックス、タブ付きコード ブロック、ページ フロントマターなど、いくつかの追加機能も追加されています。これらについては、Markdownの使い方 で説明されています。