layout: null
lang: ja
date: 2017-11-01 +0900
update: 2017-11-13 +0900
author: garin
version: 0.1.0
license: CC BY-SA 4.0

markdown 書式

Markdown を garin54/md2html で変換した時のサンプル用の Mrkdown です。
どのような出力になるかを確認できます。

// 再現方法
$ curl http://garin.jp/assets/other/markdown.md.txt -o markdown.md
$ md2html --embed --toc markdown.md > markdown.html

(この HTML は md2html 2017.10 版で変換しました)

HTML への変換

インライン

リンク

外部参照リンク

apache
apache の url

定義:
[apache]: http://apache.org

外部参照リンクの使用
[apache][]               # リンク名でリンク
[apache の url][apache]  # タイトルを指定してリンク

画像

FreeBSD Icon

画像が表示できない時の代替テキスト

サイズの指定などはできない(必要な時は HTML で書く)

絵文字

https://www.webpagefx.com/tools/emoji-cheat-sheet/

:kissing_closed_eyes: chu☆
:penguin:

(jeksyll は未対応)

inline diff

{+ additions +}
[+ additions +]

{- deletions -}
[- deletions -]

(md2html は未対応)

エスケープ

# スラッシュでエスケープ

footnote;注釈

Some text with a footnote1.

md2html では以下の形式は使えない
Some text with a footnote[This is the footnote itself.].

(jekyll, pandoc では未対応)

テーブル

orgtbl-mode 形式のテーブル が使える。
テーブルヘッダは必須。

AAA BBB CCC
a bb ccc
aaa bb c

チェックボックス

インデントは3スペース(バグ?)

orgtbl-mode の 「- [-]」 記方 にも対応

コードブロック

http://pygments.org/ の Ruby 版
https://github.com/tmm1/pygments.rb
(console, math は未対応)

ruby

hello.rb

a = aa
def hello
  puts 'The best app to log and share programming knowledge.'
end

コンソール

$ ls
test.txt

diff

--- openssl.cnf.org     2017-06-28 10:35:44.000000000 +0900
+++ openssl.cnf 2017-06-28 10:36:56.000000000 +0900
@@ -130,2 +130,2 @@
-countryName_default            = AU
+countryName_default            =

数式

$a = \{1, 2, 3\}$

よく使う指定

水平線


または


ハイライト

md2html のみ

<span> タグの highlight クラスを使う(CSS で指定)

文章の一部をハイライトします。

ブロック

セクション

markdown には <section> 用の記法はない。
this is section で代用する。
http://stackoverflow.com/questions/12593816/markdown-scoping-with-section-and-div-blocks

アサイド

md2html のみ

<aside> タグを使う

https://github.com/lord/slate/issues/236

引用

ここが引用
メールと同じ感覚で

二重引用

リスト

number disc

  1. いちばん
  2. にばん

Definition

HTML の<dl>タグをそのまま使う

リンゴ
赤いフルーツ
オレンジ
橙色のフルーツ

php-markdown には以下の書式がある

みかん
柑橘系の常緑樹から採れる果物。

md2html では暫定対応
https://gitlab.com/garin54/md2html/merge_requests/11

redcarpet ではまだ議論中
https://github.com/vmg/redcarpet/issues/108

superscript

上付き文字(sup)文字を出力

this is the 2nd time

Github Flavored Markdown

http://qiita.com/qurage/items/a2f3f52c60d7c64b2e08

改行が
そのまま改行になる

単語内アンダースコアがイタリックにならない do_this_and_do_that_and_another_thing.

チップス

iframe、script タグ

youtube

iframe タグ

元ソース: https://videos.pexels.com/videos/waterfall-stream-nature-423

ascinema

script タグ

色付きブロック

gitlab では bootstrap を使って表現している。
https://about.gitlab.com/handbook/product/technical-writing/markdown-guide/#additional-information

→ md2html では アサイド と ハイライト を使う

<div class="panel panel-info">
**Note**
{: .panel-heading}
<div class="panel-body">

NOTE DESCRIPTION

</div>
</div>

  1. jekyll header の部分が jekyll で自動削除されています 


created at: 2017-11-13 13:58:39 +0900, generated by md2html