Markdown書式

当サイトはDokuwikiにMarkdownプラグインをインストールして構築しています。その為、Wiki書式とMarkdown書式の両方が使えるのですが、Markdown書式をメインとします。Markdownプラグインが提供していない機能で必要なものはWiki表記で補うこととします。

  • Markdown書式をメインとする
  • 一部、Wiki書式で補う

ブロック要素

段落

段落は空行で分けます。

以下のように記述すると

段落1
段落1

段落2

以下のように表示されます


段落1 段落1

段落2


※ 段落を変えずに改行したい場合は行末にスペースを2つ入れます。

ヘッダ

以下のように記述します。

# ヘッダ1
## ヘッダ2
### ヘッダ3
#### ヘッダ4

引用

以下のように記述すると

> 引用1
> 引用2
> 
> 引用3
>
>
> 引用4

以下のように表示されます。

引用1引用2
引用3

引用4

箇条書き

以下のように書くと

- 箇条書き1
- 箇条書き2
 - 箇条書き21

---

 1. 箇条書き1
 2. 箇条書き2
 3. 箇条書き3

以下のように表示されます

  • 箇条書き1
  • 箇条書き2
    • 箇条書き21

  1. 箇条書き1
  2. 箇条書き2
  3. 箇条書き3

ブロック

以下のように書くと

```
文章1
文章2
```

以下のように表示されます

文章1
文章2

水平線

以下のように書くと

- - -
---
***

以下のように表示されます




範囲要素

リンク

以下の様に書くと

- [外部リンク](https://www.google.co.jp)
- [内部リンク](/doc/book/installation)
- [内部リンク(アンカー付き)](/doc/book/installation#アプリケーションの作成)
- [ページ内リンク(アンカー)](#ブロック要素)

以下のように表示されます



強調

以下のように書くと

ここが**太字**です。

ここが*斜体*です。ここも_斜体_です。

これは__下線__です。

以下のように表示されます


ここが太字です。

ここが斜体です。ここも斜体です。

これは下線です。


コード

以下のように書くと

文章の途中でも`ソースコード`が書けます

以下のように表示されます


文章の途中でもソースコードが書けます


画像

以下のように書くと

![SymfonyのBook](https://symfony.com/images/common/picto/learn_symfony_cookbook.png)

以下のように表示されます

SymfonyのBook

Wiki書式

ソースコード

DokuwikiのMarkdownプラグインではSyntaxハイライト表示をしてくれないので、Wiki書式で補います。 php, twig, yml, xml, bash等のプログラム言語のソースコードを表示する所で使います。

以下のように記述すると

<code php>
    ...
</code>

以下のように表示されます

// src/AppBundle/Controller/LuckyController.php
namespace AppBundle\Controller;

use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
use Symfony\Component\HttpFoundation\Response;

class LuckyController
{
    /**
     * @Route("/lucky/number")
     */
    public function numberAction()
    {
        $number = rand(0, 100);

        return new Response(
            '<html><body>Lucky number: '.$number.'</body></html>'
        );
    }
}

注意書き

以下のように書くと

<well>
<wrap note></wrap>
ここに文章を書きます。[リンク](http://google.com)も効きます。
</well>

以下のように表示されます

ここに文章を書きます。リンクも効きます。

以下のように書くと

<well><wrap note></wrap>注釈</well>
<well><wrap hint></wrap>ヒント</well>
<well><wrap ref></wrap>関連</well>
<well><wrap caution></wrap>注意</well>
<well><wrap addon></wrap>補足</well>

以下のように表示されます

注釈
ヒント
関連
注意
補足

タブパネル

以下のように書くと

<tabs>
  * [Twig](#tab-twig)
  * [PHP](#tab-php)

<WRAP tab-content>

<pane id="tab-twig"><code twig>
{# app/Resources/views/lucky/number.html.twig #}
{% extends 'base.html.twig' %}

{% block body %}
    <h1>Lucky Numbers: {{ luckyNumberList }}</h1>
{% endblock %}
</code></pane>

<pane id="tab-php"><code php>
<!-- app/Resources/views/lucky/number.html.php -->
<?php $view->extend('base.html.php') ?>

<?php $view['slots']->start('body') ?>
    <h1>Lucky Numbers: <?php echo $view->escape($luckyNumberList) ?>
<?php $view['slots']->stop() ?>
</code></pane>

</WRAP>
</tabs>
  • アスタリスク * の前にはスペースが2つ必要です。
  • 1ページに複数タブパネルを配置する場合は #xxxxxid="xxxxx" がページ内でユニークになるように命名してください。

以下のように表示されます

{# app/Resources/views/lucky/number.html.twig #}
{% extends 'base.html.twig' %}

{% block body %}
    <h1>Lucky Numbers: {{ luckyNumberList }}</h1>
{% endblock %}
<!-- app/Resources/views/lucky/number.html.php -->
<?php $view->extend('base.html.php') ?>

<?php $view['slots']->start('body') ?>
    <h1>Lucky Numbers: <?php echo $view->escape($luckyNumberList) ?>
<?php $view['slots']->stop() ?>

DokuwikiのMarkdownプラグインでは表を表示してくれないので、Wiki書式で補います。

以下のように書くと

^ヘッダ左寄せ  ^  ヘッダ中央  ^  ヘッダ右詰め^
|項目左寄せ    |   項目中央   |   項目右寄せ|   
|左寄せ(デフォルト)|左寄せ(デフォルト)|左寄せ(デフォルト)|

以下のように表示されます

ヘッダ左寄せ ヘッダ中央 ヘッダ右詰め
項目左寄せ 項目中央 項目右寄せ
左寄せ(デフォルト)左寄せ(デフォルト)左寄せ(デフォルト)
  • ヘッダー行のセパレータは^を使います
  • 通常の行のセパレータは|を使います
  • 項目はデフォルトで左寄せです
  • 項目を右寄せにしたい場合は値の左にスペースを2つ入れます
  • 項目をセンタリングしたい場合は値の左右にスペースを2つ入れます

アラート

以下のように書くと

<alert type="success">成功メッセージ</alert>
<alert type="info">情報メッセージ</alert>
<alert type="warning">警告メッセージ</alert>
<alert type="danger">危険/エラーメッセージ</alert>

以下のように表示されます。

ボタン

以下のように書くと

<btn>Default</btn>
<btn type="primary">Primary</btn>
<btn type="success">Success</btn>
<btn type="info">Info</btn>
<btn type="warning">Warinig</btn>
<btn type="danger">Danger</btn>

<btn size="lg">Large</btn>
<btn>Default</btn>
<btn size="sm">Small</btn>
<btn size="xs">Extra small</btn>

以下のように表示されます

Default Primary Success Info Warinig Danger

Large Default Small Extra small

画像のリンク

DokuwikiのMarkdownプラグインでは画像のリンクが出来ないので、Wiki書式で補います。
当サイトのドキュメントでは、あまり使う必要はないと思いますが…

以下のように書くと

[[http://www.symfony.com|{{https://symfony.com/images/common/picto/learn_symfony_cookbook.png}}]]

以下のように表示されます

その他