qiita-markdown 0.44.0 → 1.0.0

data/benchmark/sample.md

@@ -1,317 +0,0 @@
-Markdown記法 チートシート
-Markdown記法のチートシートです。
-本ページではQiitaで使用可能なMarkdownのみ掲載しているため、一部原文と異なります。
-Markdownの原文については、[Daring Fireball: Markdown Syntax Documentation]
-(http://daringfireball.net/projects/markdown/syntax.php)をご覧下さい。
-また、コードに関する記法は[GitHub Flavored Markdown](http://github.github.com/github-flavored-markdown/)に準拠しています。
-Qiitaでシンタックスハイライト可能な言語一覧については、 [シンタックスハイライト可能な言語](http://qiita.com/Qiita/items/e84f5aad7757afce82ba) をご覧下さい。
-
-## Code - コードの挿入
-
-たとえば、Rubyで記述したコードをファイル名「qiita.rb」として投稿したいときは、 **バッククオート** を使用して以下のように投稿するとシンタックスハイライトが適用されます。
-**コードブロック上下に空行を挿入しないと正しく表示されないことがあります。**
-
-> (空行)
-> \`\`\`ruby:qiita.rb
-> puts 'The best way to log and share programmers knowledge.'
-> \`\`\`
-> (空行)
-
-**結果**
-
-```ruby:qiita.rb
-puts 'The best way to log and share programmers knowledge.'
-```
-
-また、コードをインライン表示することも可能です。
-
-> \` puts 'Qiita'` はプログラマのための技術情報共有サービスです。
-
-**結果**
-
-` puts 'Qiita'` はプログラマのための技術情報共有サービスです。
-
-インラインコードがn個連続するバッククオートを含む場合、n+1連続のバッククオートで囲みます。
-
-> \`\` \`バッククオート\` \`\` や \`\`\` \`\`2連続バッククオート\`\` \`\`\` も記述できます。
-
-**結果**
-
-`` `バッククオート` `` や ``` ``2連続バッククオート`` ``` も記述できます。
-
-### Gist連携について
-
-##### GitHubアカウントでQiitaにログインされている場合
-
-投稿時、Octocatアイコンにチェックを入れていただくと連携を行います。
-コードを含むアイテムを投稿するとコード部分を抽出し、同じ内容がGistにも投稿される仕組みになっています。
-
-Gistとの連携は、
-
-* コードの投稿
-* Qiita側でのコードの編集
-
-の２点について連携しています。
-Gist側でコードを編集されても、 **Qiitaには反映されません** のでご注意下さい。
-
-## Format Text - テキストの装飾
-
-### Headers - 見出し
-
-* \# これはH1タグです
-* \## これはH2タグです
-* \###### これはH6タグです
-
-### Emphasis - 強調
-
-```markdown
-_イタリック体_を使うには _ か * で囲みます。
-**太字**を使うには __ か ** で囲みます。
-```
-
-_イタリック体_を使うには _ か * で囲みます。
-**太字**を使うには __ か ** で囲みます。
-
-### Strikethrough - 打ち消し線
-
-```markdown
-打ち消し線を使うには ~~ で囲みます。 ~~打ち消し~~
-```
-
-打ち消し線を使うには ~~ で囲みます。 ~~打ち消し~~
-
-イタリックや太文字と同様に前後に **半角スペース** か **改行文字** が必要です。
-
-## Lists - リスト
-
-### Disc型
-
-* 文頭に「*」「+」「-」のいずれかを入れるとDisc型リストになります
-* 要点をまとめる際に便利です
-* リストを挿入する際は、 **リストの上下に空行がないと正しく表示されません。また「*」「+」「-」の後にはスペースが必要です**
-
-### Decimal型
-
-1.  文頭に「数字.」を入れるとDecimal型リストになります
-2.  後からの挿入/移動を考慮して、1. 2. 3. と順番にするのではなく、1. 1. 1. という風に同じ数字にしておくといい具合です。
-3.  リストを挿入する際は、 **リストの上下に空行がないと正しく表示されません。また「数字.」の後にはスペースが必要です**
-
-### Definition型
-
-HTMLの`<dl>`タグをそのまま使うことで実現できます。
-
-```html
-<dl>
-  <dt>リンゴ</dt>
-  <dd>赤いフルーツ</dd>
-  <dt>オレンジ</dt>
-  <dd>橙色のフルーツ</dd>
-</dl>
-```
-次のようになります。
-
-<dl>
-<dt>リンゴ</dt>
-<dd>赤いフルーツ</dd>
-<dt>オレンジ</dt>
-<dd>橙色フルーツ</dd>
-</dl>
-
-注意するべきは、Definition型のリスト内ではMarkdown記法が使えないということです。例えば以下のように書いてはなりません。
-
-```html
-<dl>
-  <dt>リンゴ</dt>
-  <dd> とても **赤い** フルーツ </dd>
-</dl>
-```
-
-次のようになってしまいます。
-
-<dl>
-  <dt>リンゴ</dt>
-  <dd> とても **赤い** フルーツ </dd>
-</dl>
-
-Definition型リスト内ではMarkdown記法ではなくて、HTMLタグを使って修飾しなければならないので、正しくは次のようになります。
-
-```html
-<dl>
-  <dt>リンゴ</dt>
-  <dd> とても<strong>赤い</strong>フルーツ </dd>
-</dl>
-```
-
-<dl>
-  <dt>リンゴ</dt>
-  <dd> とても<strong>赤い</strong>フルーツ</dd>
-</dl>
-
-Markdown記法とHTMLタグの対応は次のようになっています。
-
-|    修飾    |   Markdown      |     HTML                 |
-|:----------:|:---------------:|:------------------------:|
-| ボールド   | `**  **`        | `<strong></strong>`      |
-| イタリック | `_  _`          | `<em></em>`              |
-| コード     | <code>``</code> | `<code></code>`          |
-| リンク     | `[text](url)`   | `<a href="url">text</a>` |
-
-## Blockquotes - 引用
-
-> \> 文頭に>を置くことで引用になります。
-> \> 複数行にまたがる場合、改行のたびにこの記号を置く必要があります。
-> \> **引用の上下にはリストと同じく空行がないと正しく表示されません**
-> \> 引用の中に別のMarkdownを使用することも可能です。
-
-> > これはネストされた引用です。
-
-## Horizontal rules - 水平線
-
-下記は全て水平線として表示されます
-
-> \* * *
-> \***
-> \*****
-> \- - -
-> \---------------------------------------
-
-## Links - リンク
-
-* \[リンクテキスト](URL "タイトル") 
-    * タイトル付きのリンクを投稿できます。
-
-**例**
-
-> *Markdown:* \[Qiita]\(http://qiita.com "Qiita")
-> *結果:* [Qiita](http://qiita.com "Qiita")
-
-* \[リンクテキスト](URL) 
-    * こちらはタイトル無しのリンクになります。
-
-**例**
-
-> *Markdown:* \[Qiita]\(http://qiita.com)
-> *結果:* [Qiita](http://qiita.com)
-
-- \[リンクテキスト]\[名前]
-- \[名前]:URL
-    - 同じURLへのリンクを複数箇所に設定することができます
-
-**例**
-
->
-*Markdown:*
-\[ここ]\[link-1] と \[この]\[link-1] リンクは同じになります。
-\[link-1][\] も可能です。
-\[link-1]:http://qiita.com/drafts/c686397e4a0f4f11683d
-> 
-*結果:*
-[ここ][link-1] と [この][link-1] リンクは同じになります。
-[link-1][] も可能です。
-[link-1]:http://qiita.com/drafts/c686397e4a0f4f11683d
-
-## Images - 画像埋め込み
-
-* \![代替テキスト]\(画像のURL)
-    * タイトル無しの画像を埋め込む
-* \![代替テキスト]\(画像のURL "画像タイトル")
-    * タイトル有りの画像を埋め込む
-
-**例**
-
-> *Markdown:* \![Qiita]\(http://qiita.com/icons/favicons/public/apple-touch-icon.png "Qiita")
-> *結果:*
-> ![Qiita](http://qiita.com/icons/favicons/public/apple-touch-icon.png "Qiita")
-
-## テーブル記法
-```
-| Left align | Right align | Center align |
-|:-----------|------------:|:------------:|
-| This       |        This |     This     |
-| column     |      column |    column    |
-| will       |        will |     will     |
-| be         |          be |      be      |
-| left       |       right |    center    |
-| aligned    |     aligned |   aligned    |
-```
-
-上記のように書くと，以下のように表示されます．
-
-| Left align | Right align | Center align |
-|:-----------|------------:|:------------:|
-| This       |        This |     This     |
-| column     |      column |    column    |
-| will       |        will |     will     |
-| be         |          be |      be      |
-| left       |       right |    center    |
-| aligned    |     aligned |   aligned    |
-
-## 数式の挿入
-
-コードブロックの言語指定に "math" を指定することでTeX記法を用いて数式を記述することができます。
-
-> \`\`\`math
-> \left( \sum_{k=1}^n a_k b_k \right)^{\!\!2} \leq
-> \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)
-> \`\`\`
-
-```math
-\left( \sum_{k=1}^n a_k b_k \right)^{\!\!2} \leq
-\left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)
-```
-
-`$2^3$` のように数式を "$" で挟むと行中に数式を埋め込むこともできます。
-
-> x^2 + y^2 = 1 をインライン表示すると $x^2 + y^2 = 1$ になります。
-
-ただしインライン数式の中でコントロールシンボル（`\{`のような、バックスラッシュの後に記号が続くもの）を使うと、後述のバックスラッシュによるMarkdownのエスケープと衝突してしまいます。
-
-```
-$a = \{1, 2, 3\}$
-```
-
-> $a = \{1, 2, 3\}$
-
-なので次のように二つのバックスラッシュを使います。
-
-```
-$a = \\{1, 2, 3\\}$
-```
-
-> $a = \\{1, 2, 3\\}$
-
-## 目次(TOC)の自動挿入
-
-目次は記事内の見出しを元に自動生成し、右上に自動挿入されます。詳細は[目次機能の紹介記事](http://blog.qiita.com/post/77055935852/qiita-toc)をご覧ください。
-
-## 注釈
-本文中に `[^1]` のように文字列を記述することで、脚注へのリンクを表現できます。注釈内容は、同じく本文中に `[^1]: ...` というように記述します[^1]。
-
-[^1]: 注釈内容を記述する位置は、本文の途中でも末尾でも構いません。
-
-## 絵文字
-厳密には Markdown 記法の外ですが、`:` で囲って、絵文字を埋め込めます。
-
-**例**
-
-```
-\:kissing_closed_eyes: chu☆
-```
-
-> \:kissing_closed_eyes: chu☆
-
-
-絵文字チートシート
-http://www.emoji-cheat-sheet.com/
-
-
-## その他
-
-バックスラッシュ[\\]をMarkdownの前に挿入することで、Markdownをエスケープ(無効化)することができます。
-
-**例**
-
-> \# H1
-> エスケープされています
-
-また本文では一部のHTMLタグも利用可能です。

data/lib/qiita/markdown/filters/greenmat.rb

@@ -1,38 +0,0 @@
-module Qiita
-  module Markdown
-    module Filters
-      class Greenmat < HTML::Pipeline::TextFilter
-        DEFAULT_OPTIONS = {
-          footnotes: true,
-        }.freeze
-
-        # @return [Nokogiri::HTML::DocumentFragment]
-        def call
-          Nokogiri::HTML.fragment(greenmat.render(@text))
-        end
-
-        private
-
-        # Memoize.
-        # @return [Greenmat::Markdown]
-        def greenmat
-          @renderer ||= ::Greenmat::Markdown.new(
-            Qiita::Markdown::Greenmat::HTMLRenderer.new(hard_wrap: true, with_toc_data: true),
-            autolink: true,
-            fenced_code_blocks: true,
-            fenced_custom_blocks: true,
-            footnotes: options[:footnotes],
-            no_intra_emphasis: true,
-            no_mention_emphasis: true,
-            strikethrough: true,
-            tables: true,
-          )
-        end
-
-        def options
-          @options ||= DEFAULT_OPTIONS.merge(context[:markdown] || {})
-        end
-      end
-    end
-  end
-end

data/lib/qiita/markdown/greenmat/heading_rendering.rb

@@ -1,61 +0,0 @@
-module Qiita
-  module Markdown
-    module Greenmat
-      module HeadingRendering
-        def heading_counter
-          @counter ||= Hash.new(0)
-        end
-
-        class AbstractHeading
-          attr_reader :raw_body, :level, :counter, :escape_html
-          alias escape_html? escape_html
-
-          def initialize(raw_body, level, counter, escape_html = false)
-            @raw_body = raw_body
-            @level = level
-            @counter = counter
-            @escape_html = escape_html
-          end
-
-          def to_s
-            fail NotImplementedError
-          end
-
-          def increment
-            fail NotImplementedError
-          end
-
-          private
-
-          def count
-            counter[id]
-          end
-
-          def has_count?
-            count > 0
-          end
-
-          def body
-            escape_html? ? CGI.escape_html(raw_body) : raw_body
-          end
-
-          def id
-            @id ||= text.downcase.gsub(/[^\p{Word}\- ]/u, "").tr(" ", "-")
-          end
-
-          def text
-            Nokogiri::HTML.fragment(raw_body).text
-          end
-
-          def suffix
-            has_count? ? "-#{count}" : ""
-          end
-
-          def suffixed_id
-            @suffixed_id ||= "#{id}#{suffix}"
-          end
-        end
-      end
-    end
-  end
-end

data/lib/qiita/markdown/greenmat/html_renderer.rb

@@ -1,60 +0,0 @@
-require "uri"
-
-module Qiita
-  module Markdown
-    module Greenmat
-      class HTMLRenderer < ::Greenmat::Render::HTML
-        include HeadingRendering
-
-        def initialize(extensions = {})
-          super
-          @with_toc_data = extensions[:with_toc_data]
-        end
-
-        # https://github.com/vmg/redcarpet/blob/v3.2.3/ext/redcarpet/html.c#L76-L116
-        def autolink(link, link_type)
-          if link_type == :email
-            %(<a href="mailto:#{link}" class="autolink">#{link}</a>)
-          else
-            %(<a href="#{link}" class="autolink">#{link}</a>)
-          end
-        end
-
-        def header(text, level)
-          heading = heading_class.new(text, level, heading_counter)
-          heading.to_s.tap do
-            heading.increment
-          end
-        end
-
-        private
-
-        def heading_class
-          @heading_class ||= (@with_toc_data ? HeadingWithAnchor : Heading)
-        end
-
-        class Heading < AbstractHeading
-          # For reference, C implementation of Redcarpet::Render::HTML#header is the following:
-          # https://github.com/vmg/redcarpet/blob/v3.2.3/ext/redcarpet/html.c#L281-L296
-          def to_s
-            "\n<h#{level}>#{body}</h#{level}>\n"
-          end
-
-          def increment
-            # No-op
-          end
-        end
-
-        class HeadingWithAnchor < AbstractHeading
-          def to_s
-            %(\n<h#{level} id="#{suffixed_id}">#{body}</h#{level}>\n)
-          end
-
-          def increment
-            counter[id] += 1
-          end
-        end
-      end
-    end
-  end
-end

data/lib/qiita/markdown/greenmat/html_toc_renderer.rb

@@ -1,78 +0,0 @@
-module Qiita
-  module Markdown
-    module Greenmat
-      class HTMLToCRenderer < ::Greenmat::Render::HTML_TOC
-        include HeadingRendering
-
-        def initialize(extensions = {})
-          super
-          @extensions = extensions
-          @last_level = 0
-        end
-
-        # https://github.com/vmg/redcarpet/blob/v3.2.3/ext/redcarpet/html.c#L609-L642
-        def header(text, level)
-          @level_offset = level - 1 unless @level_offset
-
-          level -= @level_offset
-          level = 1 if level < 1
-
-          difference = level - @last_level
-          @last_level = level
-
-          generate_heading_html(text, level, difference)
-        end
-
-        # https://github.com/vmg/redcarpet/blob/v3.2.3/ext/redcarpet/html.c#L652-L661
-        def doc_footer
-          "</li>\n</ul>\n" * @last_level
-        end
-
-        private
-
-        def generate_heading_html(text, level, level_difference)
-          html = list_item_preceding_html(level_difference)
-
-          anchor = HeadingAnchor.new(text, level, heading_counter, escape_html?)
-          html << anchor.to_s
-          anchor.increment
-
-          html
-        end
-
-        def list_item_preceding_html(level_difference)
-          html = case
-                 when level_difference > 0
-                   "<ul>\n" * level_difference
-                 when level_difference < 0
-                   "</li>\n" << ("</ul>\n</li>\n" * level_difference.abs)
-                 else
-                   "</li>\n"
-                 end
-
-          html << "<li>\n"
-        end
-
-        def escape_html?
-          @extensions[:escape_html]
-        end
-
-        class HeadingAnchor < AbstractHeading
-          def to_s
-            "<a href=\"##{suffixed_id}\">#{body}</a>\n"
-          end
-
-          def increment
-            counter[id] += 1
-          end
-
-          private
-
-          def body
-            escape_html? ? CGI.escape_html(text) : raw_body
-          end
-        end
-      end
-    end
-  end
-end

data/spec/qiita/markdown/filters/greenmat_spec.rb

@@ -1,15 +0,0 @@
-describe Qiita::Markdown::Filters::Greenmat do
-  subject(:filter) do
-    described_class.new(markdown)
-  end
-
-  context "with headings" do
-    let(:markdown) do
-      "# foo"
-    end
-
-    it "does not generate FontAwesome classes so that we can say that they're inputted by user" do
-      expect(filter.call.to_s).to eq(%(\n<h1 id="foo">foo</h1>\n))
-    end
-  end
-end