Markdownの説明
Logostellationでは、コメントやリプライを書く際に**Markdown(マークダウン)**という記法を使用できます。このページでは、Markdownを初めて使う方でも理解できるよう、基本から解説します。
Markdownとは
Markdownは、文章構造を簡単に整えるための記法です。
通常のテキストに記号を加えるだけで、見出し・太字・リスト・リンクの提示などが可能となります。覚えやすく、読みやすい形式のため、多くのWebサービスやアプリケーションで採用されています。
基本的な書き方
見出し
見出しは#(ハッシュ記号)を使って表現します。#の数で見出しのレベルが変わります。
# 見出し 1 (最も大きい)
## 見出し 2
### 見出し 3
#### 見出し 4
表示例:
見出し 1 (最も大きい)
見出し 2
見出し 3
見出し 4
見出しの設定は文章を構造化するうえで極めて有効な手段です。Logostellationでは Markdownの見出しに基づく**段落番号（pn）**を採用しており、ページの概念のないドキュメントにおいても引用・参照箇所を一意に特定することができます。ドキュメントの作成も合わせて参照してください。
太字・斜体
テキストを強調したい場合は、**や*で囲みます。
**太字にしたいテキスト**
_斜体にしたいテキスト_
**_太字かつ斜体_**
表示例:
太字にしたいテキスト 斜体にしたいテキスト 太字かつ斜体
リスト
箇条書きリスト
-(ハイフン)または*(アスタリスク)を使います。
- 項目1
- 項目2
- 項目3
- 入れ子の項目
- 入れ子の項目2
表示例:
- 項目1
- 項目2
- 項目3
- 入れ子の項目
- 入れ子の項目2
番号付きリスト
数字と.(ピリオド)を使います。
1. 最初の項目
2. 2番目の項目
3. 3番目の項目
表示例:
- 最初の項目
- 2番目の項目
- 3番目の項目
リンク
URLや他のページへのリンクを作成できます。
[リンクのテキスト](https://example.com)
表示例:
引用
他の人の発言や重要な文章を引用する場合は、>を使います。
> これは引用文です。
> 複数行にわたって引用できます。
表示例:
これは引用文です。 複数行にわたって引用できます。
Logostellationには引用をより正確かつやりやすくするための機能が多数搭載されています。詳しくは引用についてを参照してください。
コード
プログラムのコードや、特定の文字列をそのまま表示したい場合に使います。
インラインコード
文中にコードを埋め込む場合は、`(バッククォート)で囲みます。
`code`という単語を強調したい
表示例:
codeという単語を強調したい
コードブロック
複数行のコードを表示する場合は、```(バッククォート3つ)で囲みます。
```
function hello() {
console.log("Hello, World!");
}
```
表示例:
function hello() {
console.log("Hello, World!");
}
言語名を指定すると、シンタックスハイライト(色付け)されます。
```javascript
function hello() {
console.log("Hello, World!");
}
```
水平線
区切り線を入れたい場合は、---(ハイフン3つ以上)を使います。
---
表示例:
画像
画像を表示する場合は、リンクの前に!を付けます。
Logostellationでの活用例
コメント・リプライでの使用
ワークスペース内でコメントを書く際、Markdownを使うことで情報を整理しやすくなります。
例: コメントの要点整理
## 参照箇所における疑問点
1. 前段落との論理的整合性がとれない
2. 誤字脱字が多い
3. 端的に意味がわらない
### 1.前段落との論理的整合性
Aという事象について、#pn1.1.1では
> ○○○○
> と述べられていたが、この段落では
> ××××
> と言い換えがなされており、かつその言い換えが適切ではない。より具体的には
- △△⇒▲▲
- aa⇒bb
といった変更がなされているが、なぜこのような言い換えが行われたのかについて読者を説得するに足る論拠が示されているとは言いがたい。また「△△⇒▲▲」は関係のない別の文脈を呼び出してしまう危険性があり控えた方がよいのではないだろうか。
表示例:
1.前段落との論理的整合性
Aという事象について、#pn1.1.1では
○○○○
と述べられていたが、この段落では
××××
と言い換えがなされており、かつその言い換えが適切ではない。より具体的には
- △△⇒▲▲
- aa⇒bb
といった変更がなされているが、なぜこのような言い換えが行われたのかについて読者を説得するに足る論拠が示されているとは言いがたい。また「△△⇒▲▲」は関係のない別の文脈を呼び出してしまう危険性があり控えた方がよいのではないだろうか。
よくある質問
Q. Markdownは必ず使わないといけませんか
いいえ、普通のテキストとして書いても問題ありません。より見やすくしたい場合にMarkdownを活用してください。
Q. すべてのMarkdown記法が使えますか
Logostellation では一般的な Markdown 記法に対応していますが、一部の拡張記法は使用できない場合があります。基本的な記法(見出し・太字・リスト・リンクなど)は問題なく使用できます。
Q. プレビュー機能はありますか
コメントボックス左下の全画面エディターボタンを押すとプレビューを表示しながらコメントを記載することができます。
さらに学ぶには
Markdownについてさらに詳しく知りたい場合は、以下のリソースが参考になります:
- Markdown Guide - Markdownの包括的なガイド(英語)
- CommonMark - Markdownの標準仕様