オリジナルのドキュメント
最終同期リビジョン: a0184e90
ドキュメントはAGPLv3でライセンスされています。
¶ 概要
Markdown はプレーンテキストで書式付けを行うための軽量マークアップ言語です。GitHubの ようなメジャーなコードリポジトリでドキュメンテーションを書く際のデファクト構文です。
Wiki.js は CommonMark specification の完全なサポートと追加でいくつかの便利な拡張 (Github Flavored Markdown addons を含む)を提供します。
¶ ユーザーガイド
¶ 太字
テキストの前後に 2つのアスタリスク をつけます。
¶ ショートカット
- テキストを選択し、 ツールバーの
ボタンをクリックします。 - テキストを選択し、CTRL + B を押します。
¶ 例
Lorem **ipsum** dolor
¶ イタリック (斜体)
テキストの前後に 1つのアスタリスク をつけます。
¶ ショートカット
- テキストを選択し、ツールバーの
ボタンをクリックします。 - テキストを選択し、 CTRL + I を押します。
¶ 例
Lorem *ipsum* dolor
¶ 取り消し線
テキストの前後に 2つのチルダ をつけます。
¶ ショートカット
- テキストを選択し、ツールバーの
ボタンをクリックします。
¶ 例
Lorem ~~ipsum~~ dolor
¶ 見出し
1~6個の ハッシュ記号 をテキストの前に間にスペースをあけて使用します。
Using between 1 and 6 hashtag symbol(s), followed by a space, before the text selection.
¶ ショートカット
- 使用したい行でツールバーの
ドロップダウンボタンをクリックします。 - 使用したい行で CTRL + ALT + Right を押すと見出しレベルが下ります。
- 使用したい行で CTRL + ALT + Left を押すと見出しレベルが上ります。
¶ 例
# Header 1
## Header 2
### Header 3
#### Header 4
##### Header 5
###### Header 6
¶ 下付き文字
テキストの前後に 1つのチルダ をつけます。
¶ ショートカット
- テキストを選択し、ツールバーの
ボタンをクリックします。
¶ 例
Lorem ~ipsum~ dolor
¶ 上付き文字
テキストの前後に 1つのキャレット をつけます。
¶ ショートカット
- テキストを選択し、ツールバーの
ボタンをクリックします。
¶ 例
Lorem ^ipsum^ dolor
¶ ブロック引用
各テキスト行の前にスペースを空け、大なり記号 を使用します。
¶ ショートカット
- テキストを選択し、ツールバーの
ボタンをクリックします。
¶ 例
> Lorem ipsum dolor sit amet
> Consectetur adipiscing elit
¶ スタイリング
引用のあとの別の行にクラスを追加すると、引用の見た目を変更できます:
- 青:
is-info - 緑:
is-success - 黄:
is-warning - 赤:
is-danger
> Lorem ipsum dolor sit amet
> Consectetur adipiscing elit
{.is-info}
このスタイリングはWiki.js固有のもので他のアプリケーションでは標準のブロック引用にフォールバックされます。
¶ 順序つきリスト
各テキスト行の前に 数字、ドット、スペースを続けます。
¶ ショートカット
- テキストを選択し、ツールバーの
ボタンをクリックします。
¶ 例
1. Lorem ipsum dolor sit amet
1. Consectetur adipiscing elit
1. Morbi vehicula aliquam
順序づけした数字を使用することもできますが、全ての行に 1 を使用するほうが簡単に使えます。最終的には自動的にインクリメントされて表示されるため、項目が増減した際に数字を振りなおす必要がなくなります。
¶ 順序無しリスト
各行の前にアスタリスクまたはダッシュ記号とスペースを続けて使用します。
¶ ショートカット
- テキストを選択し、ツールバーの
ボタンをクリックします。
¶ 例
- Lorem ipsum dolor sit amet
- Consectetur adipiscing elit
- Morbi vehicula aliquam
¶ スタイリング
追加で、最後の行の次の行にクラスを追加するとリストの見た目が変更できます:
links-listgrid-list
- Lorem ipsum dolor sit amet
- Consectetur adipiscing elit
- Morbi vehicula aliquam
{.links-list}
このスタイリングはWiki.js固有のもので、他のアプリケーションでは標準のリストにフォールバックされます。
¶ タスクリスト
- [ ]、または - [x]を使用します。
¶ 例
- [x] Checked task item
- [x] Another checked task item
- [ ] Unchecked task item
- <input class="task-list-item-checkbox" checked disabled type="checkbox" id="task-item-2823953"><label class="task-list-item-label" for="task-item-2823953"> Checked task item</label>
- <input class="task-list-item-checkbox" checked disabled type="checkbox" id="task-item-6347962"><label class="task-list-item-label" for="task-item-6347962"> Another checked task item</label>
- <input class="task-list-item-checkbox" disabled type="checkbox" id="task-item-1581455"><label class="task-list-item-label" for="task-item-1581455"> Unchecked task item</label>
¶ インラインコード
テキストの前後を バッククォートで囲います。
¶ ショートカット
- テキストをクリックし、ツールバーの
ボタンをクリックします。
¶ 例
Lorem `ipsum` dolor
¶ コードブロック
テキストの前後の行に3つのバッククォートだけの行を用意します。
¶ ショートカット
- Using the Code Block tool in the left toolbar.
¶ 例
```
function lorem (ipsum) {
const dolor = 'consectetur adipiscing elit'
}
```
¶ シンタックスハイライト
デフォルトではコーブロックはプレーンな整形済みテキストとして出力します。
プログラミングコードで使用する場合は、シンタックスハイライトを使用すると読みやすくなります。コードブロックにプログラミング言語を指定するには最初の3つのバッククォートの後に言語キーワードを追加します:
```java
// some code here
```
サポートされる185のプログラミング言語についてはこのリストを参照してください。
¶ 水平線
3つのダッシュ 記号の行を使用します。
¶ ショートカット
- ツールバーの
ボタンをクリックします。
¶ 例
Lorem ipsum dolor
---
Consectetur adipiscing elit
¶ 画像
 の構文を使用します。
¶ ショートカット
- 左のツールバーにある アセット ツールを使用します。
¶ 例
Consectetur  elit
¶ サイズ
画像が大き過ぎたり、全体を画像で埋めたいことがあるでしょう。
以下のフォーマットで画像パスのあとに簡単にサイズを指定できます:
いずれかの値を省略すると自動的に画像のアスペクト比を保ちます:
%など、ほかの単位も使用できます。使用可能なスペースいっぱいに画像を埋めたいときに使えます:
¶ リンク
[Link Text](Link Target) の構文を使用します。
¶ ショートカット
- 左のツールバーにある リンク ツールを使用します。
¶ 例
[Lorem ipsum](https://dolor.example.com/sit/amet)
Consectetur [adipiscing](/link/to/page) elit
¶ キーボードキー
テキストの前後を と で囲います。
¶ ショートカット
- テキストを選択し、ツールバーにある
ボタンをクリックします.
¶ 例
Lorem ipsum dolor CTRL + C