From 3e76d6565603fafa2c85ad81d7b6345c4e279c72 Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Sun, 28 May 2017 22:50:57 -0700 Subject: Rearrange all the docs to allow for a docs/major.minor/ setup --- _plugins/bugify.rb | 27 +++++++++++++ _plugins/callout.rb | 28 ++++++++++++++ _plugins/highlight_alt.rb | 95 ++++++++++++++++++++++++++++++++++++++++++++++ _plugins/markdown-block.rb | 20 ++++++++++ 4 files changed, 170 insertions(+) create mode 100644 _plugins/bugify.rb create mode 100644 _plugins/callout.rb create mode 100644 _plugins/highlight_alt.rb create mode 100644 _plugins/markdown-block.rb (limited to '_plugins') diff --git a/_plugins/bugify.rb b/_plugins/bugify.rb new file mode 100644 index 000000000..0f910718b --- /dev/null +++ b/_plugins/bugify.rb @@ -0,0 +1,27 @@ +module Jekyll + module BugFilter + def bugify(input) + upstream_map = { + "Bootstrap" => "https://github.com/twbs/bootstrap/issues/", + "Edge" => ["https://developer.microsoft.com/en-us/microsoft-edge/platform/issues/", "Edge issue"], + "A11yUserVoice" => ["https://microsoftaccessibility.uservoice.com/forums/307429-microsoft-accessibility-feedback/suggestions/", "Microsoft A11y UserVoice idea"], + "UserVoice" => ["https://wpdev.uservoice.com/forums/257854-microsoft-edge-developer/suggestions/", "Edge UserVoice idea"], + "Mozilla" => ["https://bugzilla.mozilla.org/show_bug.cgi?id=", "Mozilla bug"], + "Chromium" => ["https://bugs.chromium.org/p/chromium/issues/detail?id=", "Chromium issue"], + "WebKit" => ["https://bugs.webkit.org/show_bug.cgi?id=", "WebKit bug"], + "Safari" => ["https://openradar.appspot.com/", "Apple Safari Radar"], + "Normalize" => ["https://github.com/necolas/normalize.css/issues/", "Normalize"] + } + + upstream_map.each do |key, data| + url = data.is_a?(Array) ? data[0] : data + label = data.is_a?(Array) ? "#{data[1]} " : "" + input = input.gsub(/#{key}#(\d+)/, "#{label}#\\1") + end + + return input + end + end +end + +Liquid::Template.register_filter(Jekyll::BugFilter) diff --git a/_plugins/callout.rb b/_plugins/callout.rb new file mode 100644 index 000000000..58453ecb4 --- /dev/null +++ b/_plugins/callout.rb @@ -0,0 +1,28 @@ +# Source: https://stackoverflow.com/questions/19169849/how-to-get-markdown-processed-content-in-jekyll-tag-plugin + +module Jekyll + module Tags + class CalloutTag < Liquid::Block + + def initialize(tag_name, type, tokens) + super + type.strip! + if %w(info danger warning).include?(type) + @type = type + else + puts "#{type} callout not supported. Defaulting to info" + @type = "info" + end + end + + def render(context) + site = context.registers[:site] + converter = site.find_converter_instance(::Jekyll::Converters::Markdown) + output = converter.convert(super(context)) + "
#{output}
" + end + end + end +end + +Liquid::Template.register_tag('callout', Jekyll::Tags::CalloutTag) diff --git a/_plugins/highlight_alt.rb b/_plugins/highlight_alt.rb new file mode 100644 index 000000000..8a86a2202 --- /dev/null +++ b/_plugins/highlight_alt.rb @@ -0,0 +1,95 @@ +module Jekyll + module Tags + class ExampleBlock < Liquid::Block + include Liquid::StandardFilters + + # The regular expression syntax checker. Start with the language specifier. + # Follow that by zero or more space separated options that take one of three + # forms: name, name=value, or name="" + # + # is a space-separated list of numbers + SYNTAX = /^([a-zA-Z0-9.+#-]+)((\s+\w+(=((\w|[0-9_-])+|"([0-9]+\s)*[0-9]+"))?)*)$/ + + def initialize(tag_name, markup, tokens) + super + if markup.strip =~ SYNTAX + @lang = $1.downcase + @options = {} + if defined?($2) && $2 != '' + # Split along 3 possible forms -- key="", key=value, or key + $2.scan(/(?:\w+(?:=(?:(?:\w|[0-9_-])+|"[^"]*")?)?)/) do |opt| + key, value = opt.split('=') + # If a quoted list, convert to array + if value && value.include?("\"") + value.gsub!(/"/, "") + value = value.split + end + @options[key.to_sym] = value || true + end + end + @options[:linenos] = false + else + raise SyntaxError.new <<-eos +Syntax Error in tag 'example' while parsing the following markup: + + #{markup} + +Valid syntax: example +eos + end + end + + def render(context) + prefix = context["highlighter_prefix"] || "" + suffix = context["highlighter_suffix"] || "" + code = super.to_s.strip + + output = case context.registers[:site].highlighter + + when 'rouge' + render_rouge(code) + end + + rendered_output = example(code) + add_code_tag(output) + prefix + rendered_output + suffix + end + + def example(output) + "
\n#{output}\n
" + end + + def remove_holderjs(code) + code = code.gsub(/data-src="holder.js.+?"/, 'src="..."') + end + + def remove_example_classes(code) + # Find `bd-` classes and remove them from the highlighted code. Because of how this regex works, it will also + # remove classes that are after the `bd-` class. While this is a bug, I left it because it can be helpful too. + # To fix the bug, replace `(?=")` with `(?=("|\ ))`. + code = code.gsub(/(?!class=".)\ *?bd-.+?(?=")/, "") + # Find empty class attributes after the previous regex and remove those too. + code = code.gsub(/\ class=""/, "") + end + + def render_rouge(code) + require 'rouge' + formatter = Rouge::Formatters::HTML.new(line_numbers: @options[:linenos], wrap: false) + lexer = Rouge::Lexer.find_fancy(@lang, code) || Rouge::Lexers::PlainText + code = remove_holderjs(code) + code = remove_example_classes(code) + code = formatter.format(lexer.lex(code)) + "
#{code}
" + end + + def add_code_tag(code) + # Add nested tags to code blocks + code = code.sub(/
\n*/,'
')
+        code = code.sub(/\n*<\/pre>/,"
") + code.strip + end + + end + end +end + +Liquid::Template.register_tag('example', Jekyll::Tags::ExampleBlock) diff --git a/_plugins/markdown-block.rb b/_plugins/markdown-block.rb new file mode 100644 index 000000000..f9f1531b5 --- /dev/null +++ b/_plugins/markdown-block.rb @@ -0,0 +1,20 @@ +module Jekyll + class MarkdownBlock < Liquid::Block + alias_method :render_block, :render + + def initialize(tag_name, markup, tokens) + super + end + + # Uses the default Jekyll markdown parser to + # parse the contents of this block + # + def render(context) + site = context.registers[:site] + converter = site.find_converter_instance(::Jekyll::Converters::Markdown) + converter.convert(render_block(context)) + end + end +end + +Liquid::Template.register_tag('markdown', Jekyll::MarkdownBlock) -- cgit v1.2.3