PGColonyはプログラミングの師匠や仲間と出会えるサービスです。
Markdown 記法の使い方(記入法/サンプル)
見出し
行の先頭で「#」を記述する事で、重ねた数により、第一見出し(h1)から第六見出し(h6)に変換して表示します。
見出しにマウスオーバーすると、見出しに対するリンクが末尾に自動で表示されます。
また見出しは自動で目次が作成されます。
記述例:
# h1の見出し
## h2の見出し
### h3の見出し
#### h4の見出し
##### h5の見出し
###### h6の見出し
斜体
テキストを「*」もしくは「_」1つで囲むと、斜体で表示されます。
記述例:*サンプル* もしくは _サンプル_
表示例:サンプル もしくは サンプル
強調
テキストを「**」もしくは「__」で囲むと、太字で強調表示されます。
記述例:**サンプル** もしくは __サンプル__
表示例:サンプル もしくは サンプル
取り消し
テキストを「~~」で囲むと、取り消し線付で表示されます。
記述例:~~サンプル~~
表示例:サンプル
箇条書き
数字無し
行の先頭で「*」「-」「+」のいずれかを記述し、半角スペースを空けて、内容を書くことで、リスト表示します。
記述例:
- サンプル
- サンプル
- サンプル
表示例:
- サンプル
- サンプル
- サンプル
数字有
「*」「-」「+」の代わりに「数字.」を使うことで、数字付の箇条書きで表示できます。
「数字.」に使う数字は全て「1」にしても正しく連番が採番されます。
記述例:
1. サンプル
1. サンプル
1. サンプル
表示例:
- サンプル
- サンプル
- サンプル
チェックリスト
行の先頭で以下のルールで記述して、チェックリストを表示します。
「*」「-」「+」のいずれか + 半角スペース + 「[ ]」「[x]」のいずれか + 半角スペース + テキスト
「[x]」にした場合にチェックが入ります。
「[ ]」は、括弧の間に半角スペースが1つ含まれる事に注意してください。
記述例:
- [ ] チェック1
- [x] チェック2
表示例:
- チェック1
- チェック2
階層化
リストの中に半角スペースを2つ空けて更にリスト記述をする事で、階層化した箇条書きを表示します。
記述例:
1. サンプル
* サンプル2列目
* サンプル3列目
1. サンプル
* サンプル2列目
1. サンプル3列目
1. サンプル3列目
表示例:
- サンプル
- サンプル2列目
- サンプル3列目
- サンプル2列目
- サンプル
- サンプル2列目
- サンプル3列目
- サンプル3列目
- サンプル2列目
引用
行頭に「>」と半角スペースで始める事により、引用表現を表示します。「>」を重ねる事で、階層化した引用表現となります。
複数行に渡る場合は、毎行の行頭に「>」と半角スペースの記述が必要です。
記述例:
> これは引用表現のサンプルです。
> 複数行をまとめて書けます。
>> 引用を階層化する事もできます。
>> 「>」を重ねて書いてください。
表示例:
これは引用表現のサンプルです。
複数行をまとめて書けます。引用を階層化する事もできます。
「>」を重ねて書いてください。
リンク
いくつかの記述方法でリンクを表現します。
タイトル無しリンク
一般的なリンクです。
記述例:[トップページ](https://pgcolony.com)
表示例:トップページ
タイトル付きリンク
リンクにフォーカスするとタイトルが表示されます。
記述例:[トップページ](https://pgcolony.com "PGColony Home")
表示例:トップページ
同一URLへのリンク
[参照ID]:遷移先URLのルールで記述することで、簡単に書けます。
記述例:
[PGColony][topPage]の[トップページ][topPage]
[topPage]:https://pgcolony.com
表示例:
PGColonyのトップページ
画像の埋め込み
画像を埋め込むことができます。
タイトル無し画像
通常の画像埋め込みです。
記述例:
表示例:代替テキスト
タイトル付き画像
画像にフォーカスするとタイトルが表示されます。
記述例:
表示例:代替テキスト
水平線
行頭から「*」もしくは「-」を半角スペースを挟んで 3 つ続けて記述すると水平線を表現します。
記述例:* * *
表示例:
表
一定のルールで記述することで、表(テーブル)を表示できます。
通常記法
Markdown で一般的な記述方法です。上下を改行で1行ずつ空けて、記述例のように書いてください。
「:」の位置で、左寄せ、右寄せなどを指定できます。列の幅は文字数の長いものに調整されます。
|左寄せ |右寄せ |中央寄せ|
|:-----|------:|:----:|
|文章 |文章 |文章 |
|文章 |文章 |文章 |
|文章 |文章 |文章 |
|文章 |文章 |文章 |
表示例:
左寄せ | 右寄せ | 中央寄せ |
---|---|---|
文章 | 文章 | 文章 |
文章 | 文章 | 文章 |
文章 | 文章 | 文章 |
文章 | 文章 | 文章 |
タイトル付きの表
「%%% t1 name=表名」と「%%%」で表記述を囲う事で表にタイトルを付けられます。
%%% t1 name=タイトル
|左寄せ |右寄せ |中央寄せ|
|:-----|------:|:----:|
|文章 |文章 |文章 |
|文章 |文章 |文章 |
|文章 |文章 |文章 |
|文章 |文章 |文章 |
%%%
表示例:
左寄せ | 右寄せ | 中央寄せ |
---|---|---|
文章 | 文章 | 文章 |
文章 | 文章 | 文章 |
文章 | 文章 | 文章 |
文章 | 文章 | 文章 |
コードのインライン表示
「`」で文字を囲うことで、コードを文中で表示できます。
記述例:コードを`console.log("sample.")`と書きます。
表示例:コードをconsole.log("sample.")
と書きます。
コードのブロック表示
シンプル
「```」でコードを囲う事で、ブロック表示できます。
記述例:
```
def test
puts "Hello World!!"
end
```
表示例:
def test
puts "Hello World!!"
end
タイトル付き
「```言語:ファイル名」のように記述して、タイトルを表示できます。
記述例:
```ruby:sample.rb
def test
puts "Hello World!!"
end
```
表示例:
def test
puts "Hello World!!"
end
TeX記法による数式の記述
言語部分に「math」を指定する事で、TeX記法で数式を表現できます。
記述例:
```math
x = {-b \pm \sqrt{b^2-4ac} \over 2a}
```
表示例:
x=−b±√b2−4ac2a表示切り替え付き
表示切り替えのボタンを追加できます。
記述例:
```ruby:sample.rb:true
def test
puts "Hello World!!"
end
```
表示例:
動画の埋め込み
youtube の動画のみ埋め込みができます。
動画URLが「https://www.youtube.com/watch?v=amS3L16fX7I」の場合、以下のように記述します。
記述例:
%%% youtube id=amS3L16fX7I
%%%
表示例:
スライドの埋め込み
slideshare のみ埋め込みができます。Shareに使うEmbedの Key を id 部分に使用してください。
記述例:
%%% slideshare id=GicJTUxpsEFjBV
%%%
エスケープ
Markdown記号の前に「\」(バックスラッシュ)をつける事で、Markdownのルールをスキップできます。
記述例:\記号