Markdown
Markdownは、プレーンテキストで書ける軽量なマークアップ言語です。書いたテキストは、HTMLなどに簡単に変換できます。BookStackでもMarkdownを使ってページのコンテンツを記述できます。
基本的なMarkdown記法:
-
見出し:
# 見出し1## 見出し2### 見出し3- ...のように、
#の数で見出しのレベルが変わります。 - 見出しは1~6まであり#の数で変わります
見出し1
見出し2
見出し3
見出し4
見出し5
見出し6
他のページで同じマークダウンを表示すると、CSS(デザイン)が違うので見出しのサイズや、装飾が同じにはなりません。
でんこの知識の杜のBookstackでは、上のようなデザインになっています。
本ページでは、見出しの大きさはそんなに変わりませんが、装飾が変化するようにデザインを決めています。何も装飾をつけたくないときは「見出し4」を使いましょう。
-
テキストの装飾:
- 太字:
**太字**または__太字__で囲みます。 - 斜体:
*斜体*または_斜体_で囲みます。 取り消し線:~~取り消し線~~で囲みます。
- 太字:
-
リスト:
-
箇条書き (順不同リスト):
Markdown
- 項目1 - 項目2 * 別の項目 + さらに別の項目このように、行頭に
-,*,+のいずれかを置きます。 -
番号付きリスト (順序付きリスト):
Markdown
1. 最初の項目 2. 次の項目 3. 最後の項目行頭に
数字.を置きます。
-
-
リンク:
Markdown
[表示するテキスト](URL)例:
[BookStackの公式サイト](https://www.bookstackapp.com/)
-
画像:
Markdown
例:
(代替テキストは、画像が表示されない場合に表示される説明です)
-
引用:
Markdown
> これは引用です。 > 複数行にわたる引用も可能です。行頭に
>を置きます。
-
コードブロック:
-
インラインコード: バッククォート1つ () で囲みます。例:
`print("Hello")` -
ブロックコード: バッククォート3つ (
```) で囲みます。言語を指定することもできます。Markdown
```python def hello(): print("Hello, world!") hello()
-
-
水平線:
Markdown
--- *** ___上記のいずれかを3つ以上連続して書くと、水平線が表示されます。
BookStackでのMarkdownプレビュー:
BookStackのMarkdownエディタには、記述した内容をプレビュー表示する機能があることが多いです。編集画面の近くに「プレビュー」タブやボタンがあるはずなので、それをクリックすると、Markdownで書いた内容がどのように表示されるかを確認できます。
実際に試してみましょう:
BookStackの編集画面で、上記のMarkdown記法をいくつか試してみてください。例えば、見出しを作ったり、リストを作ったり、リンクを挿入したりしてみましょう。そして、プレビューでどのように表示されるか確認してみてください。
No Comments