Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-docs.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarcia Ramos <virtua.creative@gmail.com>2017-08-07 19:51:59 +0300
committerGabriel Mazetto <brodock@gmail.com>2018-10-31 17:50:22 +0300
commitc76c418e865ed93fcd9fd45105d8b87c3d76f5ce (patch)
tree81315067388fe620a02fee502c9c5dcc28301371
parent3fb1fc62dc4d461c041d9554c56e816a0c54caeb (diff)
add kramdown as markdown engine
-rw-r--r--Gemfile2
-rw-r--r--Gemfile.lock4
-rw-r--r--Rules31
-rw-r--r--lib/helpers/redcarpet_render.rb27
-rw-r--r--lib/helpers_.rb1
5 files changed, 15 insertions, 50 deletions
diff --git a/Gemfile b/Gemfile
index bce38e21..8170df86 100644
--- a/Gemfile
+++ b/Gemfile
@@ -4,7 +4,7 @@ gem 'nanoc', '~> 4.10'
gem 'adsf', '~> 1.4'
gem 'adsf-live', '~> 1.4'
gem 'sass', '~> 3.6'
-gem 'redcarpet', '~> 3.4'
+gem 'kramdown'
gem 'rouge', '~> 2.2'
gem 'rake', '~> 12.3'
diff --git a/Gemfile.lock b/Gemfile.lock
index 5fc76a14..2be98543 100644
--- a/Gemfile.lock
+++ b/Gemfile.lock
@@ -47,6 +47,7 @@ GEM
highline (2.0.0)
http_parser.rb (0.6.0)
json_schema (0.19.1)
+ kramdown (1.14.0)
listen (3.1.5)
rb-fsevent (~> 0.9, >= 0.9.4)
rb-inotify (~> 0.9, >= 0.9.7)
@@ -84,7 +85,6 @@ GEM
rb-fsevent (0.10.3)
rb-inotify (0.9.10)
ffi (>= 0.5.0, < 2)
- redcarpet (3.4.0)
ref (2.0.0)
rouge (2.2.1)
ruby_dep (1.5.0)
@@ -110,10 +110,10 @@ DEPENDENCIES
builder (~> 3.2)
guard-nanoc (~> 2.1)
highline (~> 2.0)
+ kramdown
nanoc (~> 4.10)
nokogiri (~> 1.7.0)
rake (~> 12.3)
- redcarpet (~> 3.4)
rouge (~> 2.2)
sass (~> 3.6)
scss_lint (~> 0.57)
diff --git a/Rules b/Rules
index 3f247bad..d64c9d89 100644
--- a/Rules
+++ b/Rules
@@ -53,7 +53,7 @@ compile '/**/*.html' do
end
compile '/**/*.md' do
- if item[:redirect_to].nil?
+ if item[:redirect].nil?
# If 'toc' is absent in a file's yaml frontmatter, show ToC.
# Set to 'toc: false' to disable it.
@@ -62,24 +62,17 @@ compile '/**/*.md' do
# GitLab price / tiers specific badges
filter :badges
- # Use Redcarpet with Rouge.
- filter :redcarpet,
- renderer: HTML,
- options: {
- fenced_code_blocks: true,
- footnotes: true,
- lax_spacing: true,
- no_intra_emphasis: true,
- space_after_headers: true,
- strikethrough: true,
- superscript: true,
- tables: true,
- autolink: true,
- },
- renderer_options: {
- with_toc_data: true
- },
- with_toc: include_toc
+ # Use Kramdown with Rouge.
+ # https://kramdown.gettalong.org/options.html
+ filter :kramdown,
+ input: 'GFM',
+ syntax_highlighter: 'rouge',
+ hard_wrap: false,
+ auto_ids: true,
+ toc_levels: 2..5
+
+ filter :colorize_syntax,
+ default_colorizer: :rouge
filter :md_to_html_ext
filter :admonition
diff --git a/lib/helpers/redcarpet_render.rb b/lib/helpers/redcarpet_render.rb
deleted file mode 100644
index 35f100eb..00000000
--- a/lib/helpers/redcarpet_render.rb
+++ /dev/null
@@ -1,27 +0,0 @@
-require 'redcarpet'
-require 'rouge'
-require 'rouge/plugins/redcarpet'
-
-module Nanoc::Helpers
- module RedcarpetRender
- class HTML < Redcarpet::Render::HTML
- include Rouge::Plugins::Redcarpet
-
- def header(text, header_level)
- # https://github.com/cookpad/garage/blob/c817733e382c734eedba743e9103cd8a124f24eb/lib/garage/docs/anchor_building.rb#L24
- anchor = text.gsub(/\s+/, '-').gsub(/<\/?[^>]*>/, '').downcase
- # https://github.com/rails/rails/blob/e491b2c06329afb3c989261a2865d2a93c8b84b8/activesupport/lib/active_support/inflector/transliterate.rb#L86
- anchor.gsub!(/[^a-z0-9\-_]+/i, '-')
- anchor.gsub!(/39-/, '') # remove weird symbol https://gitlab.com/gitlab-com/gitlab-docs/issues/84
- anchor.squeeze!('-') # replace multiple dashes with one
- anchor.gsub!(/^-|-$/, '') # remove any first or last dashes
-
- %(<h#{header_level} id='#{anchor}'>#{text} <a class='anchor' href='##{anchor}'></a></h#{header_level}>)
- end
-
- def image(link, title, alt_text)
- %(<a target="_blank" href="#{link}"><img src="#{link}" title="#{title}" alt="#{alt_text}"/></a>)
- end
- end
- end
-end
diff --git a/lib/helpers_.rb b/lib/helpers_.rb
index de9ec533..3d107577 100644
--- a/lib/helpers_.rb
+++ b/lib/helpers_.rb
@@ -3,4 +3,3 @@ include Nanoc::Helpers::XMLSitemap
include Nanoc::Helpers::Rendering
include Nanoc::Helpers::ChildParentBetter
include Nanoc::Helpers::EditOnGitLab
-include Nanoc::Helpers::RedcarpetRender