KibelaではMarkdown(マークダウン)という書式で記事を書くことができます。Markdownを使わなくても記事は書けますが、2、3個の簡単なMarkdown記法を覚えることで、構造化された読みやすい文書を書くことができます。

まずは見出し箇条書きの記法から覚えてみましょう。

基本的な記法

見出し

行頭に #  (シャープと半角スペース) をつけると見出しになります。# の直後に半角スペースが必ず必要です。# は1個から6個まで連続で書くことで、見出しレベルを変更できます。

見出しを作ることで、記事のサイドバーに目次が表示されます。

例:

# 見出しレベル1

## 見出しレベル2

### 見出しレベル3

#### 見出しレベル4

##### 見出しレベル5

###### 見出しレベル6

箇条書き

行頭に- (ハイフンと半角スペース)または*  (アスタリスクと半角スペース)をつけると箇条書きになります。また 1.  のように書くと番号付きの箇条書きになります。また行頭にスペースを4つ挿入することで、インデントすることができます。

例:

1. 林檎
2. 桃
3. 梨

- 林檎
    - 桃
        - 梨

発展的な記法

マークダウンは見出しと箇条書きだけでなく、強調やリンクなどの発展的な記法もあります。こちらも使いこなすとより読みやすい文章にできます。

強調記法

テキストを** (2つのアスタリスク)で囲むと、強調(太字)になります。また、アスタリスク1つだと強調(イタリック)になります。なお記法の前後にスペースが必要なことがあります。

例:

リンク記法

URLをそのまま書くとハイパーリンクになります。Kibela内の記事であれば、リンクテキストがタイトルに置き換えられます。
一般的なリンクは次のような書式です。

[リンクテキスト](URL)

コード記法

テキストを`(バッククォート)で囲むと、 コード片やファイル名のためのコード記法になります。コード記法は等幅フォントになります。

コードブロック記法

パラグラフを``` (バッククォート3つ)または ~~~ (チルダ3つ)で囲むと、コードブロック記法になります。
開始マーカーの直後にラベルとしてプログラミング言語名を書くと、ソースコードをその言語に従ってハイライトできます。またファイル名を書くとプログラミング言語名を推定します。ファイル名が正しく推定されない場合は、 ruby:Gemfile  というようにプログラミング言語名:ファイル名とすることもできます。

PlantUML記法

コードブロック記法に {plantuml}  というラベルを使うと、PlantUML記法になります。PlantUML記法ではPlantUMLでシーケンス図やコンポーネント図などのUMLを描画できます。

※ 初期はPlantUML記法のラベルとして plantuml を採用していましたが、現在は{plantuml} を奨励しています。

PlantUMLのサンプル集としては Real World PlantUML があります。

LaTeX記法

コードブロック記法に{latex} というラベルを使うと、LaTeX記法となりMathJaxのdisplayMathとして数式を書けるようになります。また、$` ... `$で囲むと構文は同じでMathJaxのinlineMathになり、数式をテキスト中に埋め込めるようになります。

MathJaxによるLaTeX記法のサンプル集としては  MathJax basic tutorial and quick reference があります。

HTML

KibelaではHTMLを直接書けます。マークダウンで不足がある場合は、HTMLを書くことで自由な表現ができます。
なお、一部のHTMLタグの使用を制限しています。

添付ファイル 

画像 

エディタに画像ファイルをドラッグ&ドロップすることにより、画像をアップロードして記事に埋め込むことができます。画像はHTMLタグで埋め込まれるため、widthheight を設定することでサイズの調整ができます。

画像以外のファイル 

画像以外のファイルもドラッグ&ドロップでアップロードできます。その場合は、添付ファイルへのリンクになります。なお、ファイルタイプがPDFの場合は記事にプレビューが埋め込まれます。

ショートカットキー

Windows

Ctrl + Enter

記事を保存し、記事が下書き状態の場合は記事を公開状態にします。

Ctrl + s

記事を保存します。記事の公開状態は変化しません。下書きは下書き状態のまま保存されます。

Mac

Cmd + Enter

記事を保存し、記事が下書き状態の場合は記事を公開状態にします。

Ctrl + s

記事を保存します。記事の公開状態は変化しません。下書きは下書き状態のまま保存されます。

Did this answer your question?