Markdown文書の作成方法

Markdown
test
2019/01/14 作成
2019/03/02 修正

Markdown文書の作成方法

1. 導入方法

2. 基本的な使い方

  • #：見出し．#の数を増やすと小さくなる
  • *：箇条書き．タブをつけるとネストする
  • 1.：番号付きリスト
    例：
    1.1つめq
    2. 2つめ
  • >：引用

引用の例

  • `や```でくくる：文中にコードを埋め込む
// 例
#include <stdio.h>
int main(void){return 0;}
  • *string*：イタリック(英文のみ) italic
  • **string**：太字
  • ***：水平線
  • [文字列](URL)：リンク．ただURLを記載するだけでも勝手にリンクになる
  • TOC(Table of contents)の追加：右クリック⇒Markdown TOC:Insert/updateをクリック

3. 画像

  • <img src="rain.png">で画像を表示する

4. 数式

  • texのように，$でくくると数式を記述できる．

    例：$\sigma^2 = \frac{1}{n-1} \sum_{i=1}^{n} ( x_i - \bar{x} )^2$

    ↓

    σ2=1n−1∑i=1n(xi−xˉ)2\sigma^2 = \frac{1}{n-1} \sum_{i=1}^{n} ( x_i - \bar{x} )^2

5. 表

  • 簡単な表なら以下のように書ける．
    表の前に改行を入れる

|インデックス|列1|列2|列3|
|:---|:---|--:|:--:|
|1|内容1|内容2|内容3|
|2|左詰め|右詰め|中央|

インデックス 列1 列2 列3
1 内容1 内容2 内容3
2 左詰め 右詰め 中央
  • 数値データは外部のCSVをimportしてしまうのが良い
    '@import "test.csv"
0.009389 0.007594 0.009722 64984 521260

6. UML

  • 以下のように記載すると，PlantUML記法のUML図を挿入できる．
    ```plantuml
    @startuml
    @enduml
    ```

  • PlantUMLはJDKが必要．JDKのインストールと，binフォルダへパスを通しておく必要がある．
    Jaka SE Development Kit

  • 図によってはgraphvizをインストールする必要がある．
    Graphviz
    WindowsならC:\Program Files\Graphviz*\bin\dot.exeか
    C:\Program Files (x86)\Graphviz*\bin\dot.exeにdot.exeが置かれるようインストールする

  • UML図の例：

    ```plantuml
    @startuml
    actor x
    actor y
    agent a
    agent b
    (x)-->[a]
    [a]-right->(p)
    (p)-right->[b]
    [a]-down->(q)
    [b]-down->(q)
    [b]-down->(y)
    @enduml
    ```

xyabpq

7. 書式

7.1 右揃え

htmlのstyleで指定すれば可能．
html書式になるので改行は<br>を入れる必要がある．

    <div style="text-align: right;">
    右揃え文字
    </div>
右揃え文字

7.2 改ページ

8.のpdf出力する際に任意の位置で改ページするよう指定する．
htmlのstyleで指定

    <div style="page-break-before:always"></div>

8. 出力

  • html出力
    プレビュー画面で右クリック -> HTML (offilne)でhtmlファイルを.mdと同じフォルダに生成する．
    また，右クリック -> Open in Browser でブラウザで見れる．

  • pdf出力
    HTML表示して，ブラウザでPDF保存する．
    MPEのpdf出力の選択肢としてChrome(Puppeteer)，PhantomJS, princeがあるが，以下の理由で使用できないため．

    • Pupeteerはフォントがダメ
    • PhantomJSは開発停止
    • Pupeteerは商用利用不可