markdown_views 0.4.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: cf1dc33fd63dcb76e12249d77dd4759bd68060bf
-  data.tar.gz: 363c136ece7c0080001fb4f590bb01e70675064f
+SHA256:
+  metadata.gz: f81c4a73e77188401ab48d61d0c2d74b046d47bac8564a0d614415c79b549a01
+  data.tar.gz: 1c65711a9128b8be0011b5ab9a63a3f0f800397414b54fbd1290e085f8b7ec37
 SHA512:
-  metadata.gz: 6da7e5a2607fa43d2c177a78988f7cf811bc9a41b6494b9db4689676d19a5932d50a4b916a72ac4156514729c99b9d141f70a63f04a62c00d4e566a393595dab
-  data.tar.gz: 34a616a2c482cdabfcce8e0a9b7123ad4770111ef48056d205609214c1d45c5bd2f2d5ee9dcbe714da51af64a140134a29d08e64063b318296569d4947c0c2f7
+  metadata.gz: 61d705a6332849bc8a9d54c392cb1f5075b0ce3f08af7870a878d5c5d9c3cf87964fbc9ea263c0f08a4f3310c22b382b5289c0bd062eaaca5bf3acfc9282f6a5
+  data.tar.gz: 1a22c8e30aae4fc4ff9e8c5795c70273f4bb054682ddc0e005289ed5a4680d028bf414a9b8444aee02d352a52339bb429413d964f1d3365772b1d28b6e30d47c

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014-2017 thomas morgan
+Copyright (c) 2014-2018 thomas morgan
 
 MIT License
 

data/README.md

@@ -1,13 +1,39 @@
 # MarkdownViews
 
-Make Rails 4+ handle .md templates, with optional preprocessing of ERB, HAML, etc. Easily configurable; uses RedCarpet. Also performs syntax highlighting via CodeRay.
+MarkdownViews enables Rails 5+ to process .md templates as part of `app/views/`, with optional preprocessing of ERB, HAML, etc. A `markdown()` helper is also provided for when you need Markdown for only part of a view.
 
-## Usage
+It uses CommonMarker for markdown processing and Rouge for syntax highlighting.
 
-Just create views as `some_action.html.md` instead of `some_action.html.erb`.
 
+## Usage: Views
 
-By default also strips all HTML comments from the output. This can cause issues with inline Javascript or otherwise be undesired. To disable, add the following to an initializer:
+Just create views as `some_action.html.md` instead of `some_action.html.erb` and write them with Markdown instead of HTML. You can still use ERB (or HAML, etc -- see below).
+
+    # My page title
+    
+    Hello, **<%= current_user.first_name %>**.
+    
+    ```ruby
+    def syntax_highlighting
+      'works too!'
+    end
+    ```
+
+
+## Usage: Helper
+
+MarkdownViews also includes a simple Markdown rendering helper.
+
+    <%= markdown('## Some markdown text') %>
+
+    <%= markdown do %>
+    ## Some markdown text
+    <% end %>
+
+
+## Configuration
+
+By default, all HTML comments are stripped from the output. Occasionally this can cause issues with inline Javascript or otherwise be undesired. To disable, add the following to an initializer:
 
     MarkdownViews.strip_comments = false
 
@@ -16,30 +42,31 @@ By default, all .md files are preprocessed with ERB (making them effectively .md
     MarkdownViews.preprocessor = :erb
     MarkdownViews.preprocessor = nil
 
-RedCarpet's rendering can be configured. Both rendering options and markdown options can be set. See RedCarpet's documentation for available options.
+CommonMarker's rendering can also be configured. See CommonMarker's documentation for available options.
 
-    MarkdownViews.markdown_opts.merge! fenced_code_blocks: false
+    MarkdownViews.parsing_opts -= %i(UNSAFE)
 
-    MarkdownViews.rendering_opts.merge! link_attributes: {'data-popup'=> true}
+    MarkdownViews.rendering_opts -= %i(UNSAFE TABLE_PREFER_STYLE_ATTRIBUTES)
 
-Likewise, CodeRay can be configured too:
+    MarkdownViews.extensions -= %i(autolink)
 
-    MarkdownViews.coderay_opts.merge! line_numbers: true
+Likewise, Rouge can be configured:
 
-The default CSS from CodeRay is made available via the asset pipeline. To use it, add this to your `application.css`:
+    # Use inline formatting:
+    MarkdownViews.rouge_opts.merge! formatter: Rouge::Formatters::HTMLInline.new('pastie')
 
-    *= require coderay
+    # Enable line numbers:
+    MarkdownViews.rouge_opts.merge!(
+      formatter: Rouge::Formatters::HTMLTable.new(Rouge::Formatters::HTML.new, code_class: 'rouge-highlight'),
+      wrap: false
+    )
 
+The standard CSS themes from Rouge are available via the asset pipeline. To use one, add it to your `application.css`:
 
-### Helper
+    *= require rouge.monokai
 
-MarkdownViews also includes a simple Markdown rendering helper. It uses the app-wide config already defined (see above).
+See `app/assets/stylesheets/` for the complete list.
 
-    <%= markdown('## Some markdown text') %>
-
-    <%= markdown do %>
-    ## Some markdown text
-    <% end %>
 
 ## Installation
 
@@ -51,6 +78,20 @@ And then execute:
 
     $ bundle
 
+
+## Gem versions
+
+The 0.x series used RedCarpet and CodeRay.
+(There was no 1.x series.)
+The 2.x series uses CommonMarker and Rouge.
+
+#### Upgrading from 0.x to 2.x
+
+The configuration options have changed. The defaults are roughly the same as before. However, if you had customized them previously, then it will need to be revisited.
+
+Similarly, the provided stylesheets for syntax highlighting have been changed. If you were importing the 'coderay' stylesheet before, then a new stylesheet will need to be selected. Try 'rouge.colorful' or one of the others included in app/assets/stylesheets.
+
+
 ## Contributing
 
 1. Fork it ( http://github.com/<my-github-username>/markdown_views/fork )

data/Rakefile

@@ -1,5 +1,11 @@
 require "bundler/gem_tasks"
 
 task :generate_stylesheet do
-  `coderay stylesheet > app/assets/stylesheets/coderay.css`
+  %w( base16.light base16.dark base16.solarized.light base16.solarized.dark
+      base16.monokai.light base16.monokai.dark colorful github
+      gruvbox.light gruvbox.dark igorpro molokai monokai monokai.sublime
+      pastie thankful_eyes tulip
+  ).each do |theme|
+    `rougify style #{theme} --scope .rouge-highlight > app/assets/stylesheets/rouge.#{theme}.css`
+  end
 end

data/app/assets/stylesheets/rouge.base16.dark.css

@@ -0,0 +1,78 @@
+.rouge-highlight table td { padding: 5px; }
+.rouge-highlight table pre { margin: 0; }
+.rouge-highlight, .rouge-highlight .w {
+  color: #d0d0d0;
+  background-color: #151515;
+}
+.rouge-highlight .err {
+  color: #151515;
+  background-color: #ac4142;
+}
+.rouge-highlight .c, .rouge-highlight .cd, .rouge-highlight .cm, .rouge-highlight .c1, .rouge-highlight .cs {
+  color: #505050;
+}
+.rouge-highlight .cp {
+  color: #f4bf75;
+}
+.rouge-highlight .nt {
+  color: #f4bf75;
+}
+.rouge-highlight .o, .rouge-highlight .ow {
+  color: #d0d0d0;
+}
+.rouge-highlight .p, .rouge-highlight .pi {
+  color: #d0d0d0;
+}
+.rouge-highlight .gi {
+  color: #90a959;
+}
+.rouge-highlight .gd {
+  color: #ac4142;
+}
+.rouge-highlight .gh {
+  color: #6a9fb5;
+  background-color: #151515;
+  font-weight: bold;
+}
+.rouge-highlight .k, .rouge-highlight .kn, .rouge-highlight .kp, .rouge-highlight .kr, .rouge-highlight .kv {
+  color: #aa759f;
+}
+.rouge-highlight .kc {
+  color: #d28445;
+}
+.rouge-highlight .kt {
+  color: #d28445;
+}
+.rouge-highlight .kd {
+  color: #d28445;
+}
+.rouge-highlight .s, .rouge-highlight .sb, .rouge-highlight .sc, .rouge-highlight .sd, .rouge-highlight .s2, .rouge-highlight .sh, .rouge-highlight .sx, .rouge-highlight .s1 {
+  color: #90a959;
+}
+.rouge-highlight .sr {
+  color: #75b5aa;
+}
+.rouge-highlight .si {
+  color: #8f5536;
+}
+.rouge-highlight .se {
+  color: #8f5536;
+}
+.rouge-highlight .nn {
+  color: #f4bf75;
+}
+.rouge-highlight .nc {
+  color: #f4bf75;
+}
+.rouge-highlight .no {
+  color: #f4bf75;
+}
+.rouge-highlight .na {
+  color: #6a9fb5;
+}
+.rouge-highlight .m, .rouge-highlight .mf, .rouge-highlight .mh, .rouge-highlight .mi, .rouge-highlight .il, .rouge-highlight .mo, .rouge-highlight .mb, .rouge-highlight .mx {
+  color: #90a959;
+}
+.rouge-highlight .ss {
+  color: #90a959;
+}

data/app/assets/stylesheets/rouge.base16.light.css

@@ -0,0 +1,77 @@
+.rouge-highlight table td { padding: 5px; }
+.rouge-highlight table pre { margin: 0; }
+.rouge-highlight, .rouge-highlight .w {
+  color: #303030;
+}
+.rouge-highlight .err {
+  color: #151515;
+  background-color: #ac4142;
+}
+.rouge-highlight .c, .rouge-highlight .cd, .rouge-highlight .cm, .rouge-highlight .c1, .rouge-highlight .cs {
+  color: #505050;
+}
+.rouge-highlight .cp {
+  color: #f4bf75;
+}
+.rouge-highlight .nt {
+  color: #f4bf75;
+}
+.rouge-highlight .o, .rouge-highlight .ow {
+  color: #d0d0d0;
+}
+.rouge-highlight .p, .rouge-highlight .pi {
+  color: #d0d0d0;
+}
+.rouge-highlight .gi {
+  color: #90a959;
+}
+.rouge-highlight .gd {
+  color: #ac4142;
+}
+.rouge-highlight .gh {
+  color: #6a9fb5;
+  background-color: #151515;
+  font-weight: bold;
+}
+.rouge-highlight .k, .rouge-highlight .kn, .rouge-highlight .kp, .rouge-highlight .kr, .rouge-highlight .kv {
+  color: #aa759f;
+}
+.rouge-highlight .kc {
+  color: #d28445;
+}
+.rouge-highlight .kt {
+  color: #d28445;
+}
+.rouge-highlight .kd {
+  color: #d28445;
+}
+.rouge-highlight .s, .rouge-highlight .sb, .rouge-highlight .sc, .rouge-highlight .sd, .rouge-highlight .s2, .rouge-highlight .sh, .rouge-highlight .sx, .rouge-highlight .s1 {
+  color: #90a959;
+}
+.rouge-highlight .sr {
+  color: #75b5aa;
+}
+.rouge-highlight .si {
+  color: #8f5536;
+}
+.rouge-highlight .se {
+  color: #8f5536;
+}
+.rouge-highlight .nn {
+  color: #f4bf75;
+}
+.rouge-highlight .nc {
+  color: #f4bf75;
+}
+.rouge-highlight .no {
+  color: #f4bf75;
+}
+.rouge-highlight .na {
+  color: #6a9fb5;
+}
+.rouge-highlight .m, .rouge-highlight .mf, .rouge-highlight .mh, .rouge-highlight .mi, .rouge-highlight .il, .rouge-highlight .mo, .rouge-highlight .mb, .rouge-highlight .mx {
+  color: #90a959;
+}
+.rouge-highlight .ss {
+  color: #90a959;
+}

data/app/assets/stylesheets/rouge.base16.monokai.dark.css

@@ -0,0 +1,78 @@
+.rouge-highlight table td { padding: 5px; }
+.rouge-highlight table pre { margin: 0; }
+.rouge-highlight, .rouge-highlight .w {
+  color: #f8f8f2;
+  background-color: #272822;
+}
+.rouge-highlight .err {
+  color: #272822;
+  background-color: #f92672;
+}
+.rouge-highlight .c, .rouge-highlight .cd, .rouge-highlight .cm, .rouge-highlight .c1, .rouge-highlight .cs {
+  color: #75715e;
+}
+.rouge-highlight .cp {
+  color: #f4bf75;
+}
+.rouge-highlight .nt {
+  color: #f4bf75;
+}
+.rouge-highlight .o, .rouge-highlight .ow {
+  color: #f8f8f2;
+}
+.rouge-highlight .p, .rouge-highlight .pi {
+  color: #f8f8f2;
+}
+.rouge-highlight .gi {
+  color: #a6e22e;
+}
+.rouge-highlight .gd {
+  color: #f92672;
+}
+.rouge-highlight .gh {
+  color: #66d9ef;
+  background-color: #272822;
+  font-weight: bold;
+}
+.rouge-highlight .k, .rouge-highlight .kn, .rouge-highlight .kp, .rouge-highlight .kr, .rouge-highlight .kv {
+  color: #ae81ff;
+}
+.rouge-highlight .kc {
+  color: #fd971f;
+}
+.rouge-highlight .kt {
+  color: #fd971f;
+}
+.rouge-highlight .kd {
+  color: #fd971f;
+}
+.rouge-highlight .s, .rouge-highlight .sb, .rouge-highlight .sc, .rouge-highlight .sd, .rouge-highlight .s2, .rouge-highlight .sh, .rouge-highlight .sx, .rouge-highlight .s1 {
+  color: #a6e22e;
+}
+.rouge-highlight .sr {
+  color: #a1efe4;
+}
+.rouge-highlight .si {
+  color: #cc6633;
+}
+.rouge-highlight .se {
+  color: #cc6633;
+}
+.rouge-highlight .nn {
+  color: #f4bf75;
+}
+.rouge-highlight .nc {
+  color: #f4bf75;
+}
+.rouge-highlight .no {
+  color: #f4bf75;
+}
+.rouge-highlight .na {
+  color: #66d9ef;
+}
+.rouge-highlight .m, .rouge-highlight .mf, .rouge-highlight .mh, .rouge-highlight .mi, .rouge-highlight .il, .rouge-highlight .mo, .rouge-highlight .mb, .rouge-highlight .mx {
+  color: #a6e22e;
+}
+.rouge-highlight .ss {
+  color: #a6e22e;
+}

data/app/assets/stylesheets/rouge.base16.monokai.light.css

@@ -0,0 +1,77 @@
+.rouge-highlight table td { padding: 5px; }
+.rouge-highlight table pre { margin: 0; }
+.rouge-highlight, .rouge-highlight .w {
+  color: #49483e;
+}
+.rouge-highlight .err {
+  color: #272822;
+  background-color: #f92672;
+}
+.rouge-highlight .c, .rouge-highlight .cd, .rouge-highlight .cm, .rouge-highlight .c1, .rouge-highlight .cs {
+  color: #75715e;
+}
+.rouge-highlight .cp {
+  color: #f4bf75;
+}
+.rouge-highlight .nt {
+  color: #f4bf75;
+}
+.rouge-highlight .o, .rouge-highlight .ow {
+  color: #f8f8f2;
+}
+.rouge-highlight .p, .rouge-highlight .pi {
+  color: #f8f8f2;
+}
+.rouge-highlight .gi {
+  color: #a6e22e;
+}
+.rouge-highlight .gd {
+  color: #f92672;
+}
+.rouge-highlight .gh {
+  color: #66d9ef;
+  background-color: #272822;
+  font-weight: bold;
+}
+.rouge-highlight .k, .rouge-highlight .kn, .rouge-highlight .kp, .rouge-highlight .kr, .rouge-highlight .kv {
+  color: #ae81ff;
+}
+.rouge-highlight .kc {
+  color: #fd971f;
+}
+.rouge-highlight .kt {
+  color: #fd971f;
+}
+.rouge-highlight .kd {
+  color: #fd971f;
+}
+.rouge-highlight .s, .rouge-highlight .sb, .rouge-highlight .sc, .rouge-highlight .sd, .rouge-highlight .s2, .rouge-highlight .sh, .rouge-highlight .sx, .rouge-highlight .s1 {
+  color: #a6e22e;
+}
+.rouge-highlight .sr {
+  color: #a1efe4;
+}
+.rouge-highlight .si {
+  color: #cc6633;
+}
+.rouge-highlight .se {
+  color: #cc6633;
+}
+.rouge-highlight .nn {
+  color: #f4bf75;
+}
+.rouge-highlight .nc {
+  color: #f4bf75;
+}
+.rouge-highlight .no {
+  color: #f4bf75;
+}
+.rouge-highlight .na {
+  color: #66d9ef;
+}
+.rouge-highlight .m, .rouge-highlight .mf, .rouge-highlight .mh, .rouge-highlight .mi, .rouge-highlight .il, .rouge-highlight .mo, .rouge-highlight .mb, .rouge-highlight .mx {
+  color: #a6e22e;
+}
+.rouge-highlight .ss {
+  color: #a6e22e;
+}