premonition 2.0.1 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2aaae4cd98bc03518dfe2ff814d0686aab58f5b0370f8bb3f4d3b19eef303007
-  data.tar.gz: 28c1d9e93692de8c29affe8982accb19327e4d7fcdb32186f4d00679f8a38964
+  metadata.gz: c3696b91551d20df8b09f16875aaffa95a1910c5dc5ded8b0706cee7c11f4a9a
+  data.tar.gz: 1e8544cacc2c1f7891bb5f1cb0b68ebf97babc923301fa2226f702ac175f6b65
 SHA512:
-  metadata.gz: 647c3f5c4b253c9f13d447fdcb25e5aa83aba2ff215eb241c63d3cb1103bf26560b967697a6831f95be030691940cf2c4e599cb87f35a050766e5bb5199c87b7
-  data.tar.gz: 97837e09726a349eaf4817ebe4acb0cbd60042ca8d663c02b737f170fd5759ada261433da5f7b9691cf312aff8a73a9de4df0b2b6200c5c2820b4c39c9b43012
+  metadata.gz: 9da70c269a26ed2b973677ee951512566314327b800f85884c505687572d6de2ca5733fb5917ae97977ff420c692bed4c96fb2631187f4b858d54174c0ae769f
+  data.tar.gz: 5fa694730310a0191792c921351bdc3b0de26f995b3c7e5df22b693ddcef91f6b2451705c4efac460cfa6770cae5062421ee4e1a09787bcfd1e31930ad98e4c4

data/README.md

@@ -1,113 +1,168 @@
 # Premonition
 
-**DEMO: https://lazee.github.io/premonition-demo/ ([Source code](https://github.com/lazee/premonition-demo))**
+[Demo site](https://lazee.github.io/premonition-demo/) ([Source code](https://github.com/lazee/premonition-demo))
 
-Premonition is a [Jekyll](https://jekyllrb.com/) extension that makes it possible to add block-styled content to your site in plain Markdown.
+Premonition is a higly customizable [Jekyll](https://jekyllrb.com/) plugin that can convert Markdown block-quotes into beautiful block styled content.
 
-By adding a special header to the first line of a [block quote](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#blockquotes),
-Premonition will transform it into a markup block of your choice.
+By simply adding a custom header to the first line of a [block quote](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#blockquotes), Premonition will transform it into a markup block of your choice.
 
 <p align="center">
-<img src="https://github.com/lazee/premonition/raw/master/screen.png" height="450"/>
+<img src="https://github.com/lazee/premonition/raw/master/screen.png" height="550"/>
 </p>
 
 ## Features
 
- * Highly customizable (Create your own styles and templates easily)
- * Non-intrusive - Content are presented as block-quotes by any other renderer.
- * Easy to install
- * Comes with a stylesheet (Sass/Css) and templates for rendering typical information boxes.
- * Support for both Kramdown and RedCarpet.
+- Highly customizable (Create your own styles and templates easily)
+- Non-intrusive - Its just Markdown!
+- Easy to install
+- Comes with a default stylesheet (Sass/Css) and templates for beautiful messages boxes and citation.
+- Font Awesome 5 support
+
+## Version 4 Highlights
+
+- Jekyll [Post Excerpts](https://jekyllrb.com/docs/posts/#post-excerpts) support
+- New install command for the default stylesheet.
+- [Kramdown reference links](https://kramdown.gettalong.org/quickref.html#links-and-images) support
+- Jekyll 4 support (3.7 still supported)
+- Added support for block attributes (See documentation further down)
+- Added new citation block type.
+- Minor fixes to the Premonition stylesheet.
+- Removed the need Font Awesome css in default stylesheet, but
+  Font Awesome is still supported.
+- Other bug fixes. See HISTORY.md.
+
+See UPGRADE.md for help on how to upgrade from 2.x to 4.0.
 
 ## Requirements
 
- * Jekyll 3.7.x or higher
- * FontAwesome 4.x (If you are using the default template and styles)
+- Jekyll 3.7.x or higher (We recommend the new Jekyll 4)
 
 ## Installation
 
-Add the following line to your `Gemfile`:
+Add the following line to your `Gemfile` inside your Jekyll project folder:
 
 ```
 group :jekyll_plugins do
-  gem "premonition", "~> 2.0.0"
+  gem "premonition", "4.0.0"
 end
 ```
 
-Then add Premonition to `plugins` in `_config.yml`:
+Then add the the plugin to your `_config.yml`:
 
 ```yaml
 plugins:
-    - premonition
+  - premonition
 ```
 
-Finally run `bundle install`
+Now make sure to download the Premonition bundle:
+
+```
+bundle install
+```
+
+### Installing the default stylesheet
+
+Finally, if you want to use the default Premonition styling (You really should!), then you have to install the SASS stylesheet.
+Note: The installer expect you to have installed SASS support like it is described in the Jekyll documentation: https://jekyllrb.com/docs/step-by-step/07-assets/#sass.
+
+From your Jekyll project folder, run:
+
+```
+bundle exec jekyll premonition-install
+```
+
+This will add the `premonition.scss` file to your `_sass` folder and ask if you want to import this file into your `assets/main.scss` file.
+Both of these settings (destination folder and main file) can be configured. Run `bundle exec jekyll premonition-install --help` to see how.
+
+If you prefer CSS, then download the stylesheet/premonition.css file directly from this repo.
 
 ## Usage
 
-Premonition blocks are really just a standard Markdown blockquote where the first line must be on a
-special format to activate the transformation.
+A Premonition block is really just a standard Markdown blockquote where the first line of the block must follow a certain syntax.
+
+`> [type] "Title" [ attributes... ]`
+
+The type must be set to one of the default Premonition block types, or a type
+defined by you in `_config.yml`.
 
-`> [type] "Title"`
+The default types are:
 
-The type can be any letter string. It is used to map a block to its type configuration and/or css.
-By default the type will be added as a class to the outer `<div>` of the
-generated markup.
+- note
+- info
+- warning
+- error
+- citation
 
-Default types are:
+The _Title_ will normally be the block header. Leave it empty to disable
+the header.
 
-* note
-* info
-* warning
-* error
+_attributes_ are in use by the Citation type, but can be skipped for the other default types. See section about custom types for more info.
 
-The *Title* is the box header. It can be left empty to disable the box header:
+### Examples
 
-~~~markdown
-> warning ""
+Simple note with no header
+
+```markdown
+> note ""
 > No headers in here
-~~~
+```
+
+Note
+
+```markdown
+> note "I am a not"
+> The body of the note goes here. Premonition allows you to write any `Markdown` inside the block.
+```
 
-Example:
+Info
 
-~~~markdown
+```markdown
+> info "I am some info"
+> The body of the info box goes here. Premonition allows you to write any `Markdown` inside the block.
+```
+
+Warning
+
+```markdown
 > warning "I am a warning"
-> The body of the warning goes here. Premonition allows you to write any `Markdown` inside the block.
-~~~
+> The body of the warning box goes here. Premonition allows you to write any `Markdown` inside the block.
+```
 
-Premonition will then convert this into something like:
+Error
 
-~~~html
-<div class="premonition info"><div class="fa fa-check-square"></div><div class="content"><p class="header">Info</p><p>The body of the warning goes here. Premonition also allow you to write Markdown inside the block.</p></div></div>
-~~~
+```markdown
+> error "I am an error"
+> The body of the error box goes here. Premonition allows you to write any `Markdown` inside the block.
+```
 
-You can change the markup into anything you like by adding your own template.
+Citation (Note the use of attributes here)
+
+```markdown
+> citations "Mark Twain" [ cite = "mt" ]
+> I will be a beautiful citation quote
+```
 
 ## Configuration
 
-The templates can be customized in two eays. Either by replacing the default template, or by adding a custom template to a type.
+The templates can be customized in two eays. Either by replacing one of the default templates, or by adding a new type from scratch.
 
-All this is done inside your `_config.yml`.
+All this is done inside your `_config.yml`. Look at the [source code for our demo site](https://github.com/lazee/premonition-demo), for live examples on how configuration can be done.
 
 ### Templates
 
-Like Jekyll itself, Premonition uses the [Liquid Markup Language](https://github.com/Shopify/liquid) for its templates.
-
-Five variables are available to the template engine:
+Like Jekyll itself, Premonition uses the [Liquid Markup Language](https://github.com/Shopify/liquid) for templating.
 
-* *header* Boolean that tells you if a title exists and that a header should be added.
-* *content* The rendered content for your block.
-* *title* The block title.
-* *type* The type name (eg: note).
-* *meta* This is a hash that can contain any properties you would like to make available to your template. It is configured in `_config.yml`
+Six variables are available to the template engine:
 
-Our default template:
+- _header_ Boolean that tells you if a title exists and that a header should be added.
+- _content_ The rendered content for your block.
+- _title_ The block title.
+- _type_ The type name (eg: note).
+- _meta_ This is a hash that can contain any properties you would like to make available to your template. It is configured in `_config.yml`
+- _attrs_ These are the attributes set in the block header. Like we did in the Citation example above.
 
-~~~html
-<div class="premonition {{type}}">
-  <div class="fa {{meta.fa-icon}}"></div>
-  <div class="content">{% if header %}<p class="header">{{title}}</p>{% endif %}{{content}}</div></div>
-~~~
+Take a look at our default template inside `lib/premonition/resources.rb` to
+get an idea of how this is done.
 
 #### Overriding the default template
 
@@ -116,7 +171,7 @@ You can override the default template like this in your `_config.yml`:
 ```yaml
 premonition:
   default:
-    template: 'Liquid template goes here'
+    template: "Liquid template goes here"
 ```
 
 #### Overriding the template for a default type
@@ -126,8 +181,8 @@ If you want to override the template for one of the default types (like note), d
 ```yaml
 premonition:
   types:
-    - id: note
-      template: 'Liquid template goes here'
+    note:
+      template: "Liquid template goes here"
 ```
 
 ### Adding custom types
@@ -137,38 +192,60 @@ of the defaults, or add a new one.
 
 For each type you can
 
-* Add a custom template (template)
-* Set a default title (default_title)
-* Set meta data that can be used inside the template
+- Add a custom template (template)
+- Set a default title (default_title)
+- Set meta data that can be used inside the template
 
 Each type must have unique id (lowercase letters).
 
-~~~yaml
+```yaml
 premonition:
   types:
-    - id: custombox
+    custombox:
       meta:
-        fa-icon: fa-exclamation-circle
-    - id: advanced
-      template: 'Liquid template goes here'
-      default_title: 'MY BLOCK'
+        my-meta: "By myself"
+    advanced:
+      template: "Liquid template goes here"
+      default_title: "MY BLOCK"
       meta:
-        fa-icon: fa-exclamation-triangle
-~~~
+        my-meta: "By myself"
+```
+
+## More on styling
 
-## Styling
+As described in the Installation section above, it is pretty easy to install the default stylesheet into your project.
+But we recognize that this design probably isn't a perfect fit for everybody. Luckily you can modify it :)
 
-Premonition comes with a stylesheet you can copy into to your project. Either
-as a Sass file or as plain css. The [Jekyll Documentation](https://jekyllrb.com/docs/assets/) describes the process in great details.
+Our recommendation is to install the default stylesheet and override it in another SASS file. This way it will be
+easy to upgrade the default Stylesheet later without loosing your changes.
 
-Download the stylesheet from here : https://github.com/lazee/premonition/tree/master/stylesheet
+The [Jekyll Documentation](https://jekyllrb.com/docs/assets/) describes the process of adding your own SASS files in great details.
 
-In order to get the fancy icons, you will have to add [Font Awesome](https://fontawesome.com/) to your html header file.
-Be aware that you have to use v4.x of Font Awesome together with our CSS.
+## Font Awesome support
 
-The easiest way to get startet with Font Awesome is to add this to your html header file:
+Premonition 4.x no longer depends on Font Awesome for its default stylesheet.
+But it is still supported.
 
-~~~html
-<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css"/>
-~~~~
+To add Font Awesome support you should add something like this
+to your head template file:
+
+```
+<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.12.1/css/all.css">
+```
+
+Feel free to install it any other way you prefer, as long as you follow their
+[license](https://fontawesome.com/license/free).
+
+Now you can swith to Font Awesome for any of the default types by adding
+`fa-icon` to a types meta object. Let's say you want to replace the default error box icon with the beautiful `fa-bug` icon from Font Awesome.
+
+Then just add this to your `_config.yml`:
+
+```yml
+premonition:
+  types:
+    error:
+      fa-icon: "fa-bug"
+```
 
+Simple as that :)

data/lib/premonition.rb

@@ -1,7 +1,14 @@
+# frozen_string_literal: true
+
 require 'jekyll'
-require 'premonition/version'
-require 'premonition/resources'
-require 'premonition/hook'
+require_relative 'premonition/commands/install_scss.rb'
+require_relative 'premonition/attributes/error'
+require_relative 'premonition/attributes/stacker'
+require_relative 'premonition/attributes/parser'
+require_relative 'premonition/version'
+require_relative 'premonition/processor'
+require_relative 'premonition/resources'
+require_relative 'premonition/hook'
 
 module Jekyll
   module Premonition

data/lib/premonition/attributes/error.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'strscan'
+
+module Jekyll
+  module Premonition
+    module Attributes
+      # Public: Custom error for Premonition attributes parser errors.
+      class ParserError < StandardError
+        # Initialize a new ParserError
+        #
+        # msg - The error message
+        # raw - The raw string send to the parser initially.
+        #       Used for syntax error output. If nil syntax
+        #       error output is skipped.
+        # pos - The buffer position when error was raised.
+        #       Used in both error message and syntax error output
+        #       if raw attribute is set.
+        def initialize(msg, raw = nil, pos = 0)
+          if raw.nil?
+            super(msg)
+          else
+            super("#{msg} [#{pos}:#{raw.length}]")
+            print "Attribute syntax error:\n #{raw}\n"
+            pos.times { print ' ' }
+            print "^\n"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/premonition/attributes/parser.rb

@@ -0,0 +1,168 @@
+# frozen_string_literal: true
+
+require 'strscan'
+
+module Jekyll
+  module Premonition
+    module Attributes
+      # Public: Premonition block attributes parser.
+      #
+      # Parses attributes found in block headers like this:
+      # > "info" [ foo = abcd, bar = "zot", size = 3  ]
+      #
+      # The parser itself utilizes the StringScanner in ruby.
+      # Each character will be parsed, validated and pushed
+      # to a stack (array) according to the rules inside the
+      # parser itself.
+      #
+      # A stack object will be of a certain type:
+      #
+      # 0 : Outside an attributes block
+      # 1 : Inside an attributes block, but between keys or values
+      # 2 : Parsing an attribute key
+      # 3:  Parsing an attribute value
+      #
+      # Upon parser errors a pretty syntax error will be printed to
+      # stdout, showing where the error is.
+      class Parser
+        # Get parsed attributes as a Hash
+        attr_reader :attributes
+
+        # Initialize a new Parser AND start parsing
+        #
+        # str          - A string containing the attributes block to be parser.
+        def initialize(str)
+          @raw = str                       # Keeps th original string for later use
+          @buffer = StringScanner.new(str) # Create StringScanner buffer
+          @attributes = {}                 # Initialize the attributes hash
+          @stack = [Stacker.new(0)]        # Initialize the parser stack with initial "state"
+          parse                            # Start parsing
+        end
+
+        private
+
+        def parse
+          raise error('No attributes block found in given string') unless @raw.match(/^.*\[.*\].*/)
+
+          until @buffer.eos?
+            char = @buffer.getch
+            case @stack.last.type
+            when 0 # Outside block mode
+              push_stacker(1) if char == '['
+            when 1 # In between
+              parse_in_between(char)
+            when 2 # Key
+              parse_key(char)
+            when 3 # Value
+              parse_value(char)
+            end
+          end
+        end
+
+        def parse_in_between(char)
+          return if char == ' ' # Ignoring all spaces before, between and after keys and values.
+
+          if char == ']'
+            pop_attribute_from_stack
+            push_stacker(4)
+          elsif char == ','
+            raise error("Attribute separator ',' not allowed here.") if @attributes.length.zero?
+            push_stacker(2)
+          elsif char.match(/^[a-zA-z0-9\-_]$/)
+            push_stacker(2)
+            append_char(char)
+          else
+            raise error("Illegal character '#{char}' outside key and value")
+          end
+        end
+
+        def parse_key(char)
+          if char == '='
+            push_stacker(3)
+            value_mode('plain')
+          elsif char.match(/^[a-zA-z0-9\-_]$/)
+            append_char(char)
+          elsif char == ' '
+            m = @buffer.scan(/\s*\=\s*/)
+            raise error('Space not allowed inside attribute key') if m.nil?
+            push_stacker(3)
+            value_mode('plain')
+          else
+            raise error("Illegal character '#{char}' for attribute key")
+          end
+        end
+
+        def parse_value(char)
+          case char
+          when ']'
+            if plain_mode?
+              pop_attribute_from_stack
+              push_stacker(4)
+            end
+          when '"'
+            pop_attribute_from_stack unless plain_mode?
+            raise error('Illegal " found') unless @stack.last.value.nil? || @stack.last.value.empty?
+            value_mode('block')
+          when '\\'
+            raise error('Backslash is not allowed in unquoted values') if plain_mode?
+            raise error('Unsupported escaping of character inside string block') unless ['\\', '"'].include?(@buffer.peek(1))
+            append_char(@buffer.peek(1))
+            @buffer.pos += 1
+          when ','
+            if plain_mode?
+              pop_attribute_from_stack
+              push_stacker(1)
+            else
+              append_char(char)
+            end
+          when '='
+            raise error('Illegal use of equals character in unquoted value') if plain_mode?
+            append_char(char)
+          when ' '
+            if plain_mode?
+              raise error('Illegal spacing in unquoted value') if @buffer.check(/\s*[,\]]/).nil?
+              pop_attribute_from_stack
+              push_stacker(1)
+            else
+              append_char(char)
+            end
+          else
+            append_char(char)
+          end
+        end
+
+        def error(msg)
+          ParserError.new(msg, @raw, @buffer.pos)
+        end
+
+        def push_stacker(type)
+          @stack << Stacker.new(type)
+        end
+
+        def append_char(char)
+          @stack.last.append(char)
+        end
+
+        def pop_attribute_from_stack
+          v = @stack.pop
+          return if [0, 1, 2].include?(v.type) # Ignore these types from stack
+          k = @stack.pop
+          raise error("Expected key but got: #{k.value}, #{k.type}") unless k.type == 2
+          @attributes[k.value] = v.value
+        end
+
+        def plain_mode?
+          @stack.last.meta['mode'] == 'plain'
+        end
+
+        def block_mode?
+          @stack.last.meta['mode'] == 'block'
+        end
+
+        def value_mode(str)
+          @stack.last.meta['mode'] = str
+        end
+      end
+    end
+  end
+end

data/lib/premonition/attributes/stacker.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'strscan'
+
+module Jekyll
+  module Premonition
+    module Attributes
+      # Instances of this class are pushed onto the parser stack upon parsing of block attributes.
+      class Stacker
+        # Get the string value from the stacker
+        attr_reader :value
+        # Get the stacker type. 0 = outside block, 1 = in_between, 2 = key, 3 = value
+        attr_reader :type
+        # Get and set meta attributes for stacker. Used for setting value mode.
+        attr_accessor :meta
+
+        # Initialize a new Stacker
+        #
+        # type - The stacker type
+        def initialize(type)
+          @value = nil
+          @type = type
+          @meta = {}
+        end
+
+        # Append a char to the stacker value
+        def append(char)
+          @value = @value.nil? ? char : "#{@value}#{char}"
+        end
+      end
+    end
+  end
+end

data/lib/premonition/commands/install_scss.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'net/http'
+
+module Jekyll
+  module Premonition
+    # Public: Premonition stylesheet installer command
+    #
+    # Jekyll command that will install the Premonition stylesheet and add it to the needed resource files.
+    class InstallScssCommand < Jekyll::Command
+      class << self
+        def init_with_program(prog)
+          prog.command(:"premonition-install") do |c|
+            c.syntax 'premonition-install [options]'
+            c.description 'Install Premonition SASS stylesheet into your Jekyll site.'
+            c.option 'dest', '-d DEST', 'Where premonition.scss should be stored. (defaults to _sass/)'
+            c.option 'main', '-m DEST', 'The path to your main SASS file (defaults to assets/main.scss)'
+            c.action do |args, opts|
+              Jekyll::Premonition::InstallScssCommand.process(args, opts)
+            end
+          end
+        end
+
+        def process(_args, opts)
+          puts '== Installing Premonition Stylesheet and resources =="'
+          puts '-- premonition.scss --'
+          dest = opts['dest'].nil? || opts['dest'].empty? ? './_sass/' : File.join(opts['dest'], '')
+          main = opts['main'].nil? || opts['main'].empty? ? './assets/css/styles.scss' : opts['main']
+          raise StandardError, "#{dest} folder does not exist. Create it manually, and run script again." unless Dir.exist?(dest)
+          raise StandardError, "#{main} does not exist" unless File.exist?(main)
+
+          uri = URI('https://raw.githubusercontent.com/lazee/premonition/master/stylesheet/premonition.scss')
+          pf = "#{dest}premonition.scss"
+
+          if File.exist?(pf)
+            print "You already have #{pf} installed. Continue? [Y/n]"
+            override = gets.chomp
+            raise StandardError, 'Aborted. No harm done.' if override == 'n'
+          end
+
+          File.write(pf, Net::HTTP.get(uri))
+          puts "Saved stylesheet in #{pf}"
+
+          if File.readlines(main).grep(/\@import \"premonition\"/).any?
+            puts "#{main} already imports the Premonition stylesheet."
+          else
+            puts 'You must add Premonition to your main SASS file.'
+            print "Add '@import \"premonition\";' to end of #{main} now? [Y/n] "
+            add = gets.chomp
+            if add == 'n'
+              puts 'Ok. But then you will need to add it manually for the styling of Premonition to work.'
+            else
+              f = File.open(main, 'a')
+              f.write("\n@import \"premonition\";\n")
+              f.close
+              puts "Added Premonition stylesheet to #{main}."
+            end
+          end
+        rescue StandardError => e
+          puts "ERROR: #{e}"
+        end
+      end
+    end
+  end
+end

data/lib/premonition/hook.rb

@@ -1,82 +1,49 @@
+# frozen_string_literal: true
+
 module Jekyll
   module Premonition
+    # Registers Premonition hooks in Jekyll.
+    #
+    # Two hooks are added. One general hook for pages and another special
+    # hook for dealing with excerpts within posts.
+    #
+    # This ladder is really a hack as we scan all Markdown files and insert the
+    # excerpt ourselves in the document data. Unfortunately Jekyll prepares
+    # the excerpt way to early in the process, preventing us from hooking
+    # into it in a prober way. We only support excerpts if the excerpt_separator
+    # is explicitly set: https://jekyllrb.com/docs/posts/#post-excerpts
     class Hook < Generator
       safe true
-      priority :low
+      priority :high
 
       def initialize(p)
         super(p)
       end
 
       def generate(site)
-        @resources = Resources.new site.config
-        Hooks.register [:documents, :pages], :pre_render do |doc|
-          adder(doc)
-        end
-      end
+        resources = Resources.new site.config
+        processor = Processor.new resources
 
-      def adder(doc)
-        o = []
-        b = nil
-        doc.content.each_line do |l|
-          if blockquote?(l) && empty_block?(b)
-            if (m = l.match(/^\s*\>\s+([a-z]+)\s+\"(.*)\"$/i))
-              y, t = m.captures
-              b = { 'title' => t.strip, 'type' => y.strip.downcase, 'content' => [] }
-            else
-              o << l
-            end
-          elsif blockquote?(l) && !empty_block?(b)
-            b['content'] << l.match(/^\s*\>\s?(.*)$/i).captures[0]
-          else
-            if !blockquote?(l) && !empty_block?(b)
-              o << render_block(b)
-              b = nil
-            end
-            o << l
+        Hooks.register [:posts], :pre_render do |doc|
+          if process?(resources, doc)
+            doc.content = processor.adder(doc.content)
+            doc.data['excerpt'] = Jekyll::Excerpt.new(doc) if generate_excerpt? doc
           end
         end
-        o << render_block(b) unless empty_block?(b)
-        doc.content = o.join
-      end
 
-      def blockquote?(l)
-        l.strip.start_with?('>')
+        Hooks.register [:pages], :pre_render do |doc|
+          doc.content = processor.adder(doc.content) if process?(resources, doc)
+        end
       end
 
-      def empty_block?(b)
-        b.nil?
-      end
+      private
 
-      def render_block(b)
-        t = create_resource(b)
-        c = "#{@resources.markdown.convert(b['content'].join("\n"))}\n\n"
-        template = Liquid::Template.parse(t['template'], error_mode: :strict)
-        template.render(
-          {
-            'header' => !t['title'].nil?,
-            'title' => t['title'],
-            'content' => c,
-            'type' => b['type'],
-            'meta' => t['meta']
-          },
-          strict_variables: true
-        )
+      def generate_excerpt?(doc)
+        !doc.data['excerpt_separator'].nil? && !doc.data['excerpt_separator'].empty?
       end
 
-      def create_resource(b)
-        c = {
-          'template' => @resources.config['default']['template'],
-          'title' => @resources.config['default']['title'],
-          'meta' => @resources.config['default']['meta']
-        }
-        @resources.config['types'].each do |id, t|
-          next unless id == b['type']
-          c['title'] = b['title'].empty? || b['title'].nil? ? t['default_title'] : b['title']
-          c['template'] = t['template'] unless t['template'].nil?
-          c['meta'] = c['meta'].merge(t['meta']) unless t['meta'].nil?
-        end
-        c
+      def process?(resources, doc)
+        resources.config['extensions'].include?(File.extname(doc.relative_path)[1..-1])
       end
     end
   end

data/lib/premonition/processor.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Premonition
+    # Class that does all of the rendering magic within Premonition.
+    class Processor
+      def initialize(resources)
+        @resources = resources
+      end
+
+      # Called by the registered pre_render hooks.
+      #
+      # This function takes markdown content as input and converts
+      # all the block quotes, with a Premonition header, into html.
+      #
+      # content - Markdown content
+      def adder(content)
+        o = []
+        references = load_references(content)
+        b = nil
+        is_code_block = false
+        content.each_line do |l|
+          is_code_block = !is_code_block if code_block_line?(l)
+          if is_code_block
+            o << l
+          elsif blockquote?(l) && empty_block?(b)
+            if (m = l.to_s.match(/^\s*\>\s+([a-z]+)\s+\"(.*)\"\s+(\[.*\])?\s*$/i))
+              y, t, attrs = m.captures
+              b = { 'title' => t.strip, 'type' => y.strip.downcase, 'content' => [], 'attrs' => attrs }
+            else
+              o << l
+            end
+          elsif blockquote?(l) && !empty_block?(b)
+            b['content'] << l.to_s.match(/^\s*\>\s?(.*)$/i).captures[0]
+          else
+            if !blockquote?(l) && !empty_block?(b)
+              o << render_block(b, references)
+              b = nil
+            end
+            o << l
+          end
+        end
+        o << render_block(b, references) unless empty_block?(b)
+        o.join
+      end
+
+      private
+
+      # Find all the Kramdown reference name links.
+      # https://kramdown.gettalong.org/quickref.html#links-and-images
+      # https://github.com/lazee/premonition/issues/10
+      def load_references(content)
+        refs = ["\n"]
+        content.each_line do |l|
+          unless l.nil? || l == 0 || (l.is_a? String) 
+            refs << l if l.to_s.strip!.match(/^\[.*\]:.*\".*\"$/i)
+          end
+        end
+        refs
+      end
+
+      def code_block_line?(line)
+        line.strip.start_with?('~~~') || line.strip.start_with?('```')
+      end
+
+      def blockquote?(line)
+        line.strip.start_with?('>')
+      end
+
+      def empty_block?(block)
+        block.nil?
+      end
+
+      def render_block(block, references)
+        t = create_resource(block)
+        a = block['content'] + references
+        c = "#{@resources.markdown.convert(a.join("\n"))}\n\n"
+        attrs = {}
+
+        unless block['attrs'].nil?
+          parser = Jekyll::Premonition::Attributes::Parser.new(block['attrs'])
+          attrs = parser.attributes
+        end
+
+        template = Liquid::Template.parse(t['template'], error_mode: :strict)
+        template.render(
+          {
+            'header' => !t['title'].nil?,
+            'title' => t['title'],
+            'content' => c,
+            'type' => block['type'],
+            'meta' => t['meta'],
+            'attrs' => attrs
+          },
+          strict_variables: true
+        )
+      end
+
+      def error_template
+        <<~TEMPLATE
+          <div class="premonition error">
+            <div class="fa {{meta.pn-icon}}"></div>
+            <div class="content">
+              <p class="header">PREMONITION ERROR: Invalid box type</p>
+              You have specified an invalid box type "{{type}}". You can customize your own box types in `_config.yml`.
+              See documentation for more help.
+            </div>
+          </div>
+        TEMPLATE
+      end
+
+      def create_resource(block)
+        c = {
+          'template' => @resources.config['default']['template'],
+          'title' => @resources.config['default']['title'],
+          'meta' => @resources.config['default']['meta']
+        }
+
+        unless @resources.config['types'].include? block['type']
+          c['title'] = ''
+          c['meta'] = { 'pn-icon' => 'pn-error' }
+          c['template'] = error_template
+          return c
+        end
+
+        @resources.config['types'].each do |id, t|
+          next unless id == block['type']
+
+          c['title'] = block['title'].empty? || block['title'].nil? ? t['default_title'] : block['title']
+          c['template'] = t['template'] unless t['template'].nil?
+          c['meta'] = c['meta'].merge(t['meta']) unless t['meta'].nil?
+        end
+        c
+      end
+    end
+  end
+end

data/lib/premonition/resources.rb

@@ -1,14 +1,19 @@
+# frozen_string_literal: true
+
 module Jekyll
   module Premonition
+    # Class for loading the Premonition configuration and preparing it for use.
     class Resources
       attr_reader :config
       attr_reader :markdown
 
       def initialize(site_config)
         @config = load site_config
+        # Setup a new Markdown renderer.
         @markdown = Converters::Markdown.new site_config
       end
 
+      # Load the configuration of Premonition from Jekyll site configuration object.
       def load(site_config)
         cfg = default_config
         p = site_config['premonition'] || {}
@@ -18,33 +23,69 @@ module Jekyll
         cfg['default']['title'] = df['title'].strip unless df['title'].nil?
         cfg['default']['meta'] = cfg['default']['meta'].merge(df['meta']) unless df['meta'].nil?
         load_types p, cfg
+        load_extensions p, cfg
         cfg
       end
 
+      def default_template
+        <<~TEMPLATE
+          <div class="premonition {% if meta.style %}{{meta.style}} {% endif %}{{type}}">
+            <i class="{% if meta.fa-icon %}fas {{meta.fa-icon}}{% else %}premonition {{meta.pn-icon}}{% endif %}"></i>
+            <div class="content">
+              {% if header %}<p class="header">{{title}}</p>{% endif %}{{content}}
+            </div>
+          </div>
+        TEMPLATE
+      end
+
+      def citation_template
+        <<~TEMPLATE
+          <div class="premonition {% if meta.style %}{{meta.style}} {% endif %}{{type}}">
+            <i class="{% if meta.fa-icon %}fas {{meta.fa-icon}}{% else %}premonition {{meta.pn-icon}}{% endif %}"></i>
+            <blockquote class="content blockquote"{% if attrs.cite %} cite="{{attrs.cite}}"{% endif %}>
+              {{content}}
+              {% if header %}
+              <footer class="blockquote-footer">
+                <cite title="{{title}}">{{title}}</cite>
+              </footer>
+              {% endif %}
+            </blockquote>
+          </div>
+        TEMPLATE
+      end
+
+      # Setup the default configuration and types
       def default_config
         {
           'default' => {
-            'template' => '<div class="premonition {{type}}"><div class="fa {{meta.fa-icon}}"></div>'\
-              '<div class="content">{% if header %}<p class="header">{{title}}</p>{% endif %}{{content}}</div></div>',
-            'meta' => { 'fa-icon' => 'fa-check-square' },
+            'template' => default_template,
+            'meta' => { 'pn-icon' => 'pn-square', 'fa-icon' => nil },
             'title' => nil
           },
           'types' => {
-            'note' => { 'meta' => { 'fa-icon' => 'fa-check-square' } },
-            'info' => { 'meta' => { 'fa-icon' => 'fa-info-circle' } },
-            'warning' => { 'meta' => { 'fa-icon' => 'fa-exclamation-circle' } },
-            'error' => { 'meta' => { 'fa-icon' => 'fa-exclamation-triangle' } }
-          }
+            'note' => { 'meta' => { 'pn-icon' => 'pn-note' } },
+            'info' => { 'meta' => { 'pn-icon' => 'pn-info' } },
+            'warning' => { 'meta' => { 'pn-icon' => 'pn-warn' } },
+            'error' => { 'meta' => { 'pn-icon' => 'pn-error' } },
+            'citation' => { 'meta' => { 'pn-icon' => 'pn-quote' }, 'template' => citation_template }
+          },
+          'extensions' => %w[
+            md
+            markdown
+          ]
         }
       end
 
+      # Basic configuration validation
       def validate_defaults(df, prem)
         fail 'meta must be a hash' if !df['meta'].nil? && !df['meta'].is_a?(Hash)
         fail 'types must be a hash' if !prem['types'].nil? && !prem['types'].is_a?(Hash)
       end
 
+      # Load extra Premonition types configured/overriden in _config.yml
       def load_types(p, cfg)
         return if p['types'].nil?
+
         p['types'].each do |id, obj|
           t = type_config id, obj
           cfg['types'][id] = cfg['types'][id].merge(t) unless cfg['types'][id].nil?
@@ -52,6 +93,21 @@ module Jekyll
         end
       end
 
+      # Load extra extensions from config.
+      #
+      # We need this when looking for excerpts
+      def load_extensions(p, cfg)
+        return if p['extensions'].nil?
+        return unless p['extensions'].is_a?(Array)
+        return if p['extensions'].empty?
+
+        cfg['extensions'] = []
+        p['extensions'].each do |v|
+          cfg['extensions'] << v unless cfg['extensions'].include?(v)
+        end
+      end
+
+      # Validate a configured type and return as type hash
       def type_config(id, t)
         validate_type(id, t)
         {
@@ -61,6 +117,7 @@ module Jekyll
         }
       end
 
+      # Type validation
       def validate_type(id, t)
         fail 'id missing from type' if id.nil?
         fail "id can only be lowercase letters: #{id}" unless id[/[a-z]+/] == id

data/lib/premonition/version.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 module Jekyll
   module Premonition
-    VERSION = '2.0.1'.freeze
+    # Make sure to change this manually before a release.
+    VERSION = '4.0.1'
   end
 end

metadata

@@ -1,77 +1,125 @@
 --- !ruby/object:Gem::Specification
 name: premonition
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 4.0.1
 platform: ruby
 authors:
 - Jakob Vad Nielsen
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-02-27 00:00:00.000000000 Z
+date: 2021-01-12 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: 2.1.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: 2.1.4
 - !ruby/object:Gem::Dependency
-  name: jekyll
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.11.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.11.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+- !ruby/object:Gem::Dependency
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 0.68.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 0.72.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 0.68.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 0.72.0
 - !ruby/object:Gem::Dependency
-  name: mocha
+  name: rubocop-jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.11.2
+        version: 0.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.11.2
+        version: 0.10.0
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.1
+        version: 3.3.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.1
+        version: 3.3.5
 - !ruby/object:Gem::Dependency
   name: turn
   requirement: !ruby/object:Gem::Requirement
@@ -86,7 +134,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.7
-description: 
+description:
 email:
 - jakobvadnielsen@gmail.com
 executables: []
@@ -97,14 +145,19 @@ files:
 - LICENSE
 - README.md
 - lib/premonition.rb
+- lib/premonition/attributes/error.rb
+- lib/premonition/attributes/parser.rb
+- lib/premonition/attributes/stacker.rb
+- lib/premonition/commands/install_scss.rb
 - lib/premonition/hook.rb
+- lib/premonition/processor.rb
 - lib/premonition/resources.rb
 - lib/premonition/version.rb
 homepage: http://github.com/lazee/premonition
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -120,8 +173,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Jekyll generator that will convert special block quotes into message boxes.
 test_files: []