extended-markdown-filter 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 926044cc0267360827071a4f0423babf5d472ee7
-  data.tar.gz: 61617d15a849dbfa7d2a47d9c3d5f4e31547a110
+  metadata.gz: 555bea313bb40a9b286a9916a4bc3a87c258771d
+  data.tar.gz: 3780420bd64f8cd2034ccbecb60a34d0e467c881
 SHA512:
-  metadata.gz: 9390a90bc1fdf7bd77fb76c219e2784cc2d0f2d3ecac2965562673bfe83622e829b0b15b97b0c1973e963a704f7c7e9caab696ec14ca990a3833e00697acb07e
-  data.tar.gz: af78de390bd23151492b8262859e805ebff93d47bbe579810439e38ae59510044587e0dde0a5eecbfd836e125f80a5a01c542ef4403d38515971dfca2a332478
+  metadata.gz: a56659b608016e369af761743454e54403ebff307a5904b5a98e75c22ac672c3be491c80bc1e6c1ffc7a5d2350fa43ed43ef79c2e222e26dc37c2da2e9fde832
+  data.tar.gz: 86eb129658b054247d53dd1acb6ae9d075e94c850a79a5cecc067b0003127a6d2f7c41b5fd591753cd08750b91b4711ce1abc7b183c2ccd3544d92f9777ff9c0

data/README.md

@@ -34,3 +34,111 @@ Then just use the HTML pipeline normally.
 Because of the Liquid template engine, if you use this filter with Jekyll, you might find that your curly brace tags--such as `{{#tip}}`--disappear.
 
 You'll need to pass the context `emf_use_blocks` through your filter. This sets up a totally safe monkey-patch to convert the `{{ }}` blocks into `[[ ]]`, so that Liquid ignores them. Then, this renderer will convert the Markdown appropriately.
+
+## What does this add?
+
+You may be wondering what features this filter adds to Markdown. Great question! Here's what we've got:
+
+### Command-line highlighting
+
+A new pre block, `command-line`, adds some divs to allow for better highlighting for terminal code.
+
+#### Example
+
+    ``` command-line
+    $ git remote add origin https://github.com/<em>user</em>/<em>repo</em>.git
+    # Set a new remote
+    > origin  https://github.com/user/repo.git
+    ```
+
+* `$` represents content a user enters
+* `<em>` highlights content for the user
+* `#` represents comments
+* `>` represents output as a result of a command
+
+### Helper
+
+The `helper` notation wraps content in an [accordion fold](http://jqueryui.com/accordion/).
+
+#### Example
+
+    ``` helper
+    I'm not really important enough to show.
+    ```
+
+### Admonition blocks
+
+You can create separate, priority-colored callouts with `{{#tip}}`, `{{#warning}}`, and `{{#error}}` tags.
+
+#### Example
+
+    {{#tip}}
+
+    Here's a hot tip: **line one**
+    Here's a hot tip: line two
+
+    {{/tip}}
+
+    {{#warning}}
+
+    Yo, check this out: line one
+    Yo, check this out: line two
+
+    {{/warning}}
+
+    {{#error}}
+
+    Sheeeeit, this is a problem: ~~line one~~
+    Sheeeeit, this is a problem: line two
+
+    {{/error}}
+
+### Intro
+
+The `intro` block demarcates a special section that provides a summary of the content to follow.
+
+#### Example
+
+    {{#intro}}
+
+    [Gists](https://gist.github.com) are a great way to share your work. You can share single files, parts of files, or full applications.
+
+    {{/intro}}
+
+### Octicon
+
+The `{{ octicon }}` helper lets you easily render [any Octicon](https://octicons.github.com/) in the content, including an aria label.
+
+#### Example
+
+    {{ octicon-gear The Settings gear }}
+
+### Operating system blocks
+
+Sometimes, certain content needs to be rendered for only a certain operating system. Use `{{#mac}}` of Mac OS specific content, `{{#windows}}` for Windows, `{{#linux}}` for Linux, and `{{#all}}` as a catch-all for everything else.
+
+#### Example
+
+    {{#mac}}
+
+    1. Command-click on the option.
+
+    {{/mac}}
+
+    {{#windows}}
+
+    1. Right click on the **Start** menu.
+
+    {{/windows}}
+
+    {{#linux}}
+
+    1. Open the terminal.
+
+    {{/linux}}
+
+    {{#all}}
+
+    1. Double-click on the icon.
+
+    {{/all}}

data/extended-markdown-filter.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "extended-markdown-filter"
-  spec.version       = "0.3.3"
+  spec.version       = "0.3.4"
   spec.authors       = ["Garen Torikian"]
   spec.email         = ["gjtorikian@gmail.com"]
   spec.summary       = %q{Add extended markup syntax to the HTML::Pipeline}

data/lib/filters/pre/command-line.rb

@@ -1,9 +1,13 @@
 module Filters
   module PreFilter
     def format_command_line!(text)
-      text.gsub! /\n?``` command-line(.+?)```/m do |block|
-        block.gsub! /^``` command-line/, '<pre class="command-line">'
-        block.gsub! /^```$/, "</pre>\n"
+      text.gsub! /((`{3}\s*)(command-line)?(\s*([\w\W]+?)\n*)\2)\n*(?:[^\S\w\s]|$)/m do |block|
+        str = $5.dup
+        return block unless str.lines.to_a[0].chomp == "command-line"
+        str = str.lines.to_a[1..-1].join
+
+        block.gsub! /``` command-line/, '<pre class="command-line">'
+        block.gsub! /```/, "</pre>\n"
         block.gsub!(/^\$ (.+)$/) { %Q|<span class="command">#{$1.rstrip}</span>| }
         block.gsub!(/^(\# .+)$/) { %Q|<span class="comment">#{$1.rstrip}</span>| }
         block.gsub!(/^> (.+)$/) { %Q|<span class="output"><span># </span>#{$1.rstrip}</span>| }

data/test/fixtures/command_line_list.md

@@ -0,0 +1,29 @@
+1. On the command line, navigate to the repository that contains the commit you want to amend.
+2. Use the `git rebase -i HEAD~n` command to display a list of the last `n` commits in your default text editor.
+  ``` command-line
+  $ git rebase -i HEAD~3 # Displays a list of the last 3 commits on the current branch
+  ```  
+  The list will look similar to the following:
+  ``` command-line
+  pick e499d89 Delete CNAME
+  pick 0c39034 Better README
+  pick f7fde4a Change the commit message but push the same commit.
+
+  # Rebase 9fdb3bd..f7fde4a onto 9fdb3bd
+  #
+  # Commands:
+  #  p, pick = use commit
+  #  r, reword = use commit, but edit the commit message
+  #  e, edit = use commit, but stop for amending
+  #  s, squash = use commit, but meld into previous commit
+  #  f, fixup = like "squash", but discard this commit's log message
+  #  x, exec = run command (the rest of the line) using shell
+  #
+  # These lines can be re-ordered; they are executed from top to bottom.
+  #
+  # If you remove a line here THAT COMMIT WILL BE LOST.
+  #
+  # However, if you remove everything, the rebase will be aborted.
+  #
+  # Note that empty commits are commented out
+  ```

data/test/test_extended_markdown_filter.rb

@@ -14,6 +14,11 @@ class HTML::Pipeline::ExtendedMarkdownFilterTest < Minitest::Test
     assert_equal 1, doc.css('span.comment').size
     assert_equal 2, doc.css('em').size
     assert_equal 1, doc.css('span.output').size
+
+    doc = ExtendedMarkdownFilter.to_document(fixture("command_line_list.md"), {})
+    assert doc.kind_of?(HTML::Pipeline::DocumentFragment)
+
+    assert_equal 2, doc.css('li pre.command-line').size
   end
 
   def test_helper

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: extended-markdown-filter
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - Garen Torikian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-06 00:00:00.000000000 Z
+date: 2014-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: html-pipeline
@@ -109,6 +109,7 @@ files:
 - test/fixtures/block_octicon.md
 - test/fixtures/block_os_blocks.md
 - test/fixtures/command_line.md
+- test/fixtures/command_line_list.md
 - test/fixtures/helper.md
 - test/fixtures/intro.md
 - test/fixtures/octicon.md
@@ -146,6 +147,7 @@ test_files:
 - test/fixtures/block_octicon.md
 - test/fixtures/block_os_blocks.md
 - test/fixtures/command_line.md
+- test/fixtures/command_line_list.md
 - test/fixtures/helper.md
 - test/fixtures/intro.md
 - test/fixtures/octicon.md