emd 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd3ac910c3743f48445bbd54b724144707ff45b3e3058d8b4dcb3f755344fd18
-  data.tar.gz: feca68b0ce825d203f547c0da3a09d098065098016d117dcbbbcdced04198b2f
+  metadata.gz: dff540501ce48aa3c7dd04006ea8b2c441c54fb097201851a80d64bee65c566c
+  data.tar.gz: 6587540baf347167d95365b0b67d066b5c1043af3c53b17740456b3713868558
 SHA512:
-  metadata.gz: cef74a0aa74e565711dc88a9a7fc3f0a77471d4bf1050f89827b438e862df197f4a8fe01b68f534ca257c64ecf172be16e73e8b9024367c75023fda7cbaf2db0
-  data.tar.gz: 66561776e714513d4fdd161a8e909daa802d5d39456e56771c674d4e99b284a9a645268ab488e2c75d02c21e698de8bce4448d83852a8dcd2604fab8b018e87b
+  metadata.gz: b6b5dc54ba17f79500cab2a400c1692b01cc29625350760aa2a97586235da020b9db379204234a956301cee4e71ada93b048885d5e5fb28a8799a6824f8298eb
+  data.tar.gz: cc25fe24687e07c5cf823db1512705681102512ab43fc68a3c0a792a770722c3113652621c41ffc62411a7ee21260e6d60184ff113788d95613c9ff8ffbb016e

data/README.md

@@ -1,34 +1,27 @@
 # Embedded Markdown [![Gem Version](https://badge.fury.io/rb/emd.svg)](https://badge.fury.io/rb/emd)
 
-Embedded Markdown uses a Rails engine and a simple initializer to initiate a markdown template handler with the help of Redcarpet and syntax highlighting from Coderay.
-
-The motivation is to reuse Markdown file in several of my Rails projects.
-
-- 😊 Reuse Markdown in Rails products
-- 📝 Allow copywriters & marketers to be involved in building your content easily 
-- 📝 Allows you to focus on the content instead of the webpage structure.  
-- 🙌 Supports syntax highlighting via Coderay
+Embedded Markdown supports Markdown in Rails views and syntax highlighting at your Markdown code block.
 
 ## Installation
 
-Add this two lines to your application's Gemfile:
+Add these lines to your application's Gemfile:
 
 ```ruby
 gem 'coderay' #optional for Syntax Highlighting
 gem 'redcarpet'
 gem 'emd'
 ```
-> emd depends on Redcarpet for Markdown rendering
 
 And then execute:
 
-    $ bundle
-
+```
+bundle
+```
 ## Usage
 
-### A Markdown view
+### Use it in a Markdown view `markdown.html.md`
 
-1. Create a view called app/view/home/markdown.html.md and add the following sample Markdown. 
+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
@@ -38,16 +31,16 @@ And then execute:
 
 1. Generate a home controller using the following command `rails generate controller home`
 
-1. At route.rb, add the following line: 
+1. Add the following line to `route.rb`: 
     ```
        get '/markdown', to: 'home#markdown'
     ```
-1. Finally, visit the markdown view at [http://localhost:3000/markdown](http://localhost:3000/markdown)
+1. And finally, visit the Markdown view at [http://localhost:3000/markdown](http://localhost:3000/markdown)
 
 
-### A Markdown partial
+### Use it in a Markdown partial `_component.html.md`
 
-1. Create a partial app/view/home/`_component.html.md`
+1. Create a `_component.html.md` partial at `app/view/home/_component.html.md`:
 
     ```markdown
         ### This is a component
@@ -57,7 +50,14 @@ And then execute:
         - [This is a link to google] (http://google.com)
     ```
 
-1. Then,  use this partial using `<%= render "component" %>` within any view like index.html.erb
+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'
+    ```
+1. And finally, visit the Rails view with Markdown partial at [http://localhost:3000/home](http://localhost:3000/home)
+
 
 ### Syntax Highlighting
 
@@ -72,13 +72,15 @@ This will turn all the code block into:
 
 ```ruby
     ```ruby
-     puts "something"
+       class Something
+       end
     ```
 ```
 
 ```ruby
-puts "something"
-```
+    class Something
+    end
+  ```
 
 ### Control which extensions Redcarpet uses
 
@@ -88,16 +90,17 @@ puts "something"
 module MarkdownTemplateHandler
   def self.call(template)
     compiled_source = erb.call(template)
-    "Redcarpet::Markdown.new(Redcarpet::Render::HTML,
-                             no_intra_emphasis: true,
-                             fenced_code_blocks: true,
+    %(Redcarpet::Markdown.new(Redcarpet::Render::HTML,
+                             no_intra_emphasis:            true,
+                             fenced_code_blocks:           true,
                              # I actually like that, so commented it out:
                              # disable_indented_code_blocks: true,
-                             space_after_headers: true,
+                             space_after_headers:          true,
                              prettify:                     true,
                              tables:                       true,
                              with_toc_data:                true,
-                             autolink: true).render(begin;#{compiled_source};end).html_safe"
+                             autolink:                     true
+                             ).render(begin;#{compiled_source};end).html_safe)
   end
 end
 ```
@@ -120,3 +123,28 @@ The gem is available as open source under the terms of the [MIT License](http://
 
 Special thanks to [these folks](http://stackoverflow.com/questions/4163560/how-can-i-automatically-render-partials-using-markdown-in-rails-3/10131299#10131299
 ) for making emd possible
+
+
+## TODO
+
+- [x] Syntax highlighting 
+- [ ] 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.
+
+The motivation is to reuse Markdown file in several of my Rails projects.
+
+- 😊 Reuse Markdown in Rails products
+- 📝 Allow copywriters & marketers to be involved in building your content easily 
+- 📝 Allows you to focus on the content instead of the webpage structure.  
+- 🙌 Supports syntax highlighting via Coderay
+
+
+## Other implementations
+- [Markdown Rails](https://github.com/joliss/markdown-rails)

data/lib/emd/version.rb

@@ -1,3 +1,3 @@
 module Emd
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: emd
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Bryan Lim
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-11 00:00:00.000000000 Z
+date: 2019-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet