markdowner 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fc407621c244d535298d5ef7bba49beaf599a4b095132bbfc90d47003401e970
+  data.tar.gz: 978c696e6f4dbbe25b72928b6ce7232ec129181b8fad2bc574359f753f506178
+SHA512:
+  metadata.gz: 1e71aa8f0072dbde4f967af7296ecf7ed80240b2395cf597985aca3a15a41d37d600161162839a3999bf68ee1b2c9fa8b2bef8cdb8f79fef8a26f1cb9bcfb356
+  data.tar.gz: 86094c20030310928836829766e9b00ade5b1264a02c78217b3ba861f7c1ca24fa1d69f981a453f3128a3f2187e7c4364e4addd828c0db0b4c0e47d78dca1af0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright elpdev
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,56 @@
+# Markdowner
+
+Simple rails gem to use Markdown files in your views.
+
+## Usage
+
+After installing the gem you can create and use markdown files in your view folders. The markdown files are rendered as html using the redcarpet gem.
+
+### Syntax Highlighting
+
+Markdowner comes with the [prismjs](https://prismjs.com/) library for syntax highlighting. You're free to use any other library you like, skip this section and include your own.
+
+- To enable it add the following to your layout.
+
+```language-erb
+ <%= stylesheet_link_tag 'markdowner/prism', media: 'all' %>
+ <%= javascript_include_tag 'markdowner/prism' %>
+```
+
+Then in your markdown file you can use the following syntax for code blocks.
+
+````markdown
+```language-ruby
+your code here
+```
+````
+
+<img width="656" alt="image" src="https://github.com/lbp-dev/markdowner/assets/148717241/090a0795-4841-4a5a-8ed6-66f77987c9ab">
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "markdowner", path: "../markdowner"
+```
+
+And then execute:
+
+```bash
+bundle
+```
+
+Or install it yourself as:
+
+```bash
+gem install markdowner
+```
+
+## Contributing
+
+Contribution directions go here.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/setup"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/lib/markdowner/engine.rb

@@ -0,0 +1,18 @@
+require_relative "handlers/markdown_handler"
+
+module Markdowner
+  class Engine < ::Rails::Engine
+    isolate_namespace Markdowner
+
+    initializer "markdowner.markdown_handler" do |app|
+      ActionView::Template.register_template_handler(
+        :md,
+        Markdowner::Handlers::MarkdownHandler.new
+      )
+    end
+
+    initializer "markdowner.assets.precompile" do |app|
+      app.config.assets.precompile += %w[markdowner/prism.js markdowner/prism.css]
+    end
+  end
+end

data/lib/markdowner/handlers/markdown_handler.rb

@@ -0,0 +1,30 @@
+require "redcarpet"
+
+module Markdowner
+  module Handlers
+    class MarkdownHandler
+      def call(template, source)
+        markdown = ::Redcarpet::Markdown.new(
+          Redcarpet::Render::HTML,
+          autolink: true,
+          tables: true,
+          fenced_code_blocks: true,
+          underline: true,
+          highlight: true,
+          quote: true,
+          footnotes: true,
+          no_styles: true,
+          hard_wrap: true,
+          prettify: true,
+          safe_links_only: true,
+          no_intra_emphasis: true,
+          strikethrough: true,
+          superscript: true,
+          lax_spacing: true,
+          space_after_headers: true
+        )
+        "#{markdown.render(source).inspect}.html_safe"
+      end
+    end
+  end
+end

data/lib/markdowner/version.rb

@@ -0,0 +1,3 @@
+module Markdowner
+  VERSION = "0.1.2"
+end

data/lib/markdowner.rb

@@ -0,0 +1,6 @@
+require "markdowner/version"
+require "markdowner/engine"
+
+module Markdowner
+  # Your code goes here...
+end

data/lib/tasks/markdowner_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :markdowner do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: markdowner
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- elpdev
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.3.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.3.4
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+description: Rails gem  that enables markdown files in your app/views directory.
+email:
+- 148717241+elpdev@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/markdowner.rb
+- lib/markdowner/engine.rb
+- lib/markdowner/handlers/markdown_handler.rb
+- lib/markdowner/version.rb
+- lib/tasks/markdowner_tasks.rake
+homepage: https://github.com/lbp-dev/markdowner
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/lbp-dev/markdowner
+  source_code_uri: https://github.com/lbp-dev/markdowner
+  changelog_uri: https://github.com/lbp-dev/markdowner/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.13
+signing_key:
+specification_version: 4
+summary: Handle markdown files in Rails applications.
+test_files: []