gitlab_kramdown 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 863ff5cdca8cd14c9de1619a1fcb4512ad12ae602a688097a4f3a03d85483d77
-  data.tar.gz: 4adb0e3732d0bf380c1e8b7afc0bc6ae4db90a39d51a6a81489d02025a5c9629
+  metadata.gz: cd0ca6d723ef2cfbc3cc3ec87d184561abea8d451172a0bb4a3a9a136e243eb7
+  data.tar.gz: 8e322c9cda56f6f730a0cae0823cf27ad2bf3092f33ef5bba04760b725e64cdc
 SHA512:
-  metadata.gz: c8d9d12504b784b056dd2ef6e49bfb9664b454b1fefd6242c388a3e6ffc52bc18d0706bd08eb907b3a5759e8cf4ac84647e4a4ac3c55334d862b65042181f6b7
-  data.tar.gz: 131c9a44c743e52ddcb74684c2236155ad89c54b073b80b1887e4213a043c821a56fcc042b1e27eb69596ae54032e17be5a71474a8adf2ecc25a057c140fe452
+  metadata.gz: f31f20474eabfe807f33e33a36cedf1487f44c0cec1a4298c7852fe68237fb7638130fdb1603e790b60a60eb1db9c0e5a2af30509b25cb387346c22247cd5a03
+  data.tar.gz: 7cf6232f7840fd12e17c294e332213b226cdbe6bcee554ccc6e6ec9e30c12333b185bdc2746cf28d3d91f97a284f63fe8583aeee0cfed9afdcb8fe26130be906

data/README.md

@@ -25,7 +25,7 @@ This is a list of GitLab Flavored Markdown (GFM) extensions and their status of
 | [Videos]                        | No           |
 | [Math]                          | No           |
 | [Colors]                        | No           |
-| [Mermaid]                       | No           |
+| [Mermaid]                       | **Yes**      |
 
 > **Note**: Extensions marked as `Kramdown` in the `Implemented?` means behavior already exists
   in Kramdown flavor.
@@ -36,6 +36,7 @@ This is a list of GitLab Flavored Markdown (GFM) extensions and their status of
 | :------------------| :------------------: | -------------------------------------------- |
 | `gitlab_url`       | `https://gitlab.com` | GitLab instance URL to build reference links |
 | `linkable_headers` | true                 | Generate anchor tags with headers?           |
+| `autolink`         | false                | Converts URLs to HTML links (can be slow)    | 
 
 ## Usage example
 

data/lib/gitlab_kramdown/converter/gitlab_html.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'kramdown/converter/html'
+
+module GitlabKramdown
+  module Converter
+    # Converts a Kramdown::Document to HTML.
+    #
+    # This includes GitLab custom elements from GitLab Flavored Markdown syntax
+    module GitlabHtml
+      # Codeblock is customized in order to implement a different output to Mermaid
+      #
+      # Mermaid requires `<div class="mermaid"></div>` surrounding the content in order
+      # to trigger the unobtrusive JS.
+      def convert_codeblock(element, opts)
+        if element.options[:lang] == 'mermaid'
+          %(<div class="mermaid">#{element.value}</div>\n)
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/gitlab_kramdown/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GitlabKramdown
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

data/lib/gitlab_kramdown.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'kramdown/parser'
+require 'kramdown/converter'
 
 # GitLab Kramdown implements Markdown flavored extensions on top of Kramdown
 #
@@ -17,7 +18,15 @@ require 'kramdown/parser'
 module GitlabKramdown
   autoload :VERSION, 'gitlab_kramdown/version'
   autoload :Parser, 'gitlab_kramdown/parser'
+
+  # Gitlab Kramdown custom Converters
+  module Converter
+    autoload :GitlabHtml, 'gitlab_kramdown/converter/gitlab_html'
+  end
 end
 
 # Autoload extensions
 Kramdown::Parser.autoload :GitlabKramdown, 'kramdown/parser/gitlab_kramdown'
+
+# Custom HTML extensions
+Kramdown::Converter::Html.prepend(GitlabKramdown::Converter::GitlabHtml)

data/lib/kramdown/parser/gitlab_kramdown.rb

@@ -21,11 +21,13 @@ module Kramdown
         super
 
         @options[:gitlab_url] ||= 'https://gitlab.com'
+        @options[:autolink] = false if @options[:autolink].nil?
         @options[:linkable_headers] = true if @options[:linkable_headers].nil?
         @id_counter = Hash.new(-1)
 
+        prepend_span_parsers(:gitlab_autolink) if @options[:autolink]
         prepend_span_parsers(:escape_chars_gitlab, :commit_diff, :commit, :user_group_mention,
-                             :issue, :merge_request, :snippet, :label, :gitlab_autolink, :strikethrough_gitlab)
+                             :issue, :merge_request, :snippet, :label, :strikethrough_gitlab)
         prepend_block_parsers(:fenced_blockquote)
         replace_block_parser!(:codeblock_fenced, :codeblock_fenced_gitlab)
         replace_block_parser!(:atx_header, :atx_gitlab_header)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_kramdown
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Gabriel Mazetto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-09 00:00:00.000000000 Z
+date: 2019-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -162,6 +162,7 @@ files:
 - LICENSE.txt
 - README.md
 - lib/gitlab_kramdown.rb
+- lib/gitlab_kramdown/converter/gitlab_html.rb
 - lib/gitlab_kramdown/parser.rb
 - lib/gitlab_kramdown/parser/autolink.rb
 - lib/gitlab_kramdown/parser/escape.rb
@@ -195,7 +196,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: GitLab Flavored Kramdown