emd 0.3.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e66aeb72d6524a402d6ae0e0c358c242db505bd81454cec6b691b3389be9e0f
-  data.tar.gz: 617d76dcac2415626e8741ec5d82bb9c2f605d9cb26913270319ec9c404931d6
+  metadata.gz: 1057ad153eab8a0f90c99e96bf865fe7c91c42b5dad62a85c9b0faea346182e1
+  data.tar.gz: 598ea55c1fda7b8b58ba6e3cd4f15925d6178b229bc7089c15384852474a9fb6
 SHA512:
-  metadata.gz: 52048091556900764629114ec23a354eaecf2450ca1eeb93f3e523e753097eb73a1c3f6a0699a7df807d856ea6398f2907d97d4dbed47e8608863e02a31a5c50
-  data.tar.gz: ea1ce9268f980bff0ca8067fc024a118eb0745fbaa16f13fa06fb2591490cc43c55b2a175285869154323f0d9739ab5f43da65668cd700757cf6fddbab89f47a
+  metadata.gz: 962543192bd7344fe0eed7b1321ed148f5983cf849e972c0fcc9eaf775a1b37a586fe0b5ab9a94828d90f1afe757c8eccd4a4a6114d4f9ee248dd7acdeb6b8e7
+  data.tar.gz: ab22746d9fa60ffd996cd07c24adadbcee89d01d254de75c394d4141327b5e81e4711c4e724ace98c5200653943f4123e1853a60663c03a70c6ee38fdf73a9c1

data/README.md

@@ -23,18 +23,18 @@ bundle
 
 1. Create a `markdown.html.md` view at `app/view/home/markdown.html.md` and add the following Markdown code:
 
-    ```markdown
-        ## This is a sample Markdown code
-        - [google](http://google.com)
-        - [emd](https://github.com/ytbryan/emd/)
-    ```
+```markdown
+## This is a sample Markdown code
+- [google](http://google.com)
+- [emd](https://github.com/ytbryan/emd/)
+```
 
 1. Generate a home controller using the following command `rails generate controller home`
 
 1. Add the following line to `route.rb`: 
-    ```
-       get '/markdown', to: 'home#markdown'
-    ```
+```
+get '/markdown', to: 'home#markdown'
+```
 1. And finally, visit the Markdown view at [http://localhost:3000/markdown](http://localhost:3000/markdown)
 
 
@@ -42,20 +42,20 @@ bundle
 
 1. Create a `_component.html.md` partial at `app/view/home/_component.html.md`:
 
-    ```markdown
-        ### This is a component
+```markdown
+### This is a component
 
-        - This is item 1
-        - This is iiem 2
-        - [This is a link to google] (http://google.com)
-    ```
+- This is item 1
+- This is iiem 2
+- [This is a link to google] (http://google.com)
+```
 
 1. Use this partial using `<%= render "component" %>` within any view like at `home/index.html.erb`
 
 1. Add the following line to `route.rb`: 
-    ```
-       get '/home', to: 'home#index'
-    ```
+```
+get '/home', to: 'home#index'
+```
 1. And finally, visit the Rails view with Markdown partial at [http://localhost:3000/home](http://localhost:3000/home)
 
 
@@ -72,15 +72,56 @@ This will turn all the code block into:
 
 ```ruby
     ```ruby
-       class Something
-       end
+        class Something
+        end
     ```
 ```
 
 ```ruby
-    class Something
-    end
-  ```
+class Something
+end
+```
+
+Also, you can enable inline code highlighting by adding `code` style to your `index.css`
+
+```
+code {
+  background-color: rgba(27,31,35,.1);
+  border-radius: 3px;
+  font-size: 85%;
+  margin: 0;
+  padding: .2em .4em;
+}
+```
+
+### Enable number lines in your markdown's code block
+
+To display number lines in your code block, add `emd.js` in `app/assets/javascripts/application.js`
+
+```javascript
+//= require emd
+//= require_tree .
+```
+
+And add `emd.css` in `app/assets/stylesheets/application.css`
+
+```css
+*= require emd
+*= require_self
+```
+
+### Changing the color of the code block
+
+To change the color of the code block, please use the following css selector: 
+
+```css
+div.code pre {
+  background-color: #fff;
+}
+```
+
+The default color is `#eee`
+
 
 ### Control which extensions Redcarpet uses
 
@@ -128,12 +169,14 @@ Special thanks to [these folks](http://stackoverflow.com/questions/4163560/how-c
 ## TODO
 
 - [x] Syntax highlighting 
+- [x] Number lines in code block
 - [ ] Tests
 - [ ] Scaffolders
 - [ ] Example repo
 - [ ] Add a copy button to the code block
 
 
+
 ## Benefits
 
 EMD uses a Rails engine and a simple initializer to initiate a markdown template handler with the help of Redcarpet and syntax highlighting from Coderay.

data/app/assets/javascripts/emd.js

@@ -0,0 +1,12 @@
+document.addEventListener('DOMContentLoaded', () => {
+  var pre = document.getElementsByTagName('pre'),
+  pl = pre.length;
+  for (var i = 0; i < pl; i++) {
+    pre[i].innerHTML = '<span class="line-number"></span>' + pre[i].innerHTML + '<span class="cl"></span>';
+    var num = pre[i].innerHTML.split(/\n/).length;
+    for (var j = 0; j < (num - 1); j++) {
+        var line_num = pre[i].getElementsByTagName('span')[0];
+        line_num.innerHTML += '<span>' + (j + 1) + '</span>';
+    }
+  }
+})

data/app/assets/stylesheets/emd.scss

@@ -0,0 +1,36 @@
+pre {
+  display: block;
+  margin-top: 0;
+  margin-bottom: 1rem;
+  font-size: 0.7rem;
+  line-height: 1.4;
+  white-space: pre;
+  overflow: auto;
+  background-color:#eee;
+  border: 1px solid #ddd;
+  padding: .5rem;
+  max-height: 800px;
+  font-family: monospace;
+  code {
+    color: inherit;
+    background-color: transparent;
+    padding: 0;
+    display: block;
+  }
+  .line-number {
+    display: block;
+    float: left;
+    margin: 0 1em 0 -1em;
+    border-right: 1px solid #ddd;
+    text-align: right;
+    span {
+      display: block;
+      padding: 0 .5em 0 1em;
+      color: #ccc;
+    }
+  }
+  .cl {
+    display: block;
+    clear: both;
+  }
+}

data/config/initializers/markdown_template_handler.rb

@@ -1,7 +1,7 @@
 class CodeRayify < Redcarpet::Render::HTML
   def block_code(code, language)
     if !Gem.loaded_specs.has_key?('coderay') ||  language == nil || language == "" 
-      %(<pre>#{code}</pre>)
+      %(<div class="CodeRay"><div class="code"><pre>#{code}</pre></div></div>)
     else 
       CodeRay.scan(code, language).div 
     end
@@ -13,10 +13,15 @@ module MarkdownTemplateHandler
     @erb ||= ActionView::Template.registered_template_handler(:erb)
   end
 
-  def self.call(template)
-    compiled_source = erb.call(template)
+  def self.call(template, source = nil)
+
+    compiled_source = if source
+      erb.call(template, source)
+    else
+      erb.call(template)
+    end
     
-    %(Redcarpet::Markdown.new(CodeRayify.new(:filter_html => true, 
+    %(Redcarpet::Markdown.new(CodeRayify.new(:filter_html => false, 
                                             :hard_wrap => true),
                             no_intra_emphasis:            true,
                             fenced_code_blocks:           true,

data/lib/emd/version.rb

@@ -1,3 +1,3 @@
 module Emd
-  VERSION = "0.3.1"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: emd
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Bryan Lim
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-07-18 00:00:00.000000000 Z
+date: 2021-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: 3.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: 3.5.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.1.2
+        version: 1.1.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.1.2
+        version: 1.1.3
 description: Embedded markdown template for Ruby on Rails
 email:
 - ytbryan@gmail.com
@@ -74,6 +74,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
+- app/assets/javascripts/emd.js
+- app/assets/stylesheets/emd.scss
 - app/helpers/emd_helper.rb
 - config/initializers/markdown_template_handler.rb
 - lib/emd.rb
@@ -101,8 +103,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Markdown partial and .html.md on Rails View
 test_files: []