phlex-markdown 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70814edaf961f6b8b86c4918d06a92cb9d9d890dd7614dea761a03982b0ff8ce
-  data.tar.gz: 5fc9e240f463805e88d718f5b1fe5ce2a9d099367cac196288b68657bd895505
+  metadata.gz: 3e4546655748fea3f6ab3004ff7d67d12b95e461d7a29ad6f876fd7998ee0444
+  data.tar.gz: a3bbde5d84b3d9642df40079b7f3f2bc36489e6dbda19205e2fe674adce6335a
 SHA512:
-  metadata.gz: cf89b40b70e6d5fe0ed463e7756b6ba9f236eb95c1a23a6786e43df0f992bcf2d10f03c1dda23ec63f10058256e0c5704c35269a2bdd941a0f110fb3110cbdc5
-  data.tar.gz: 56f39bdc50391a200f938a841637618d406eee64ea2d3e217dbc12b6636a4b0fe06d2bd58285de1cdf1980b35737be4528b5fc19113e18157c209136dfc21997
+  metadata.gz: 390f03b1b399c1c62bb4d844dbb253539661fda7b39f6b2c08c514905d7fc18184292a1e09b0dbb89e80a2acfba8d141506076f2fa978ec05cc5e8967a530594
+  data.tar.gz: f8ca5719060e644e31e9be6ef9d37dbf5904f55d5a834d2dd3beaa30721adc5cb075557e28f40eef30ebb87d0def4bcda9b8f8bdd2e5aa27ce9cedc91f4f6d3b

data/.editorconfig

@@ -11,3 +11,7 @@ indent_size = 2
 [*.erb]
 indent_style = space
 indent_size = 2
+
+[*.md]
+indent_style = space
+indent_size = 2

data/README.md

@@ -1,5 +1,52 @@
 # `phlex-markdown`
 
+`Phlex::Markdown` is a [Phlex](https://phlex.fun) view that renders Markdown into HTML using Phlex. You could use it directly — it takes a String of markdown and renders it to safe HTML.
+
+Alternatively, you can define a sub-class and override various methods to customise the output.
+
+For example, here we override `h1` and `ul`, adding some Tailwind classes to them.
+
+```ruby
+class MyMarkdown < Phlex::Markdown
+  def h1 = super(class: "font-bold text-xl")
+  def ul = super(class: "ml-4 pt-2")
+end
+```
+
+When we render the view.
+
+```ruby
+content = <<~MD
+  # Hello World
+
+  - A
+  - B
+  - C
+MD
+
+output = MyMarkdown.new(content).call
+```
+
+The `output` will use the attributes from our methods.
+
+```html
+<h1 class="font-bold text-xl">Hello World</h1>
+<ul class="ml-4 pt-2">
+  <li>A</li>
+  <li>B</li>
+  <li>C</li>
+</ul>
+```
+
+You could also wrap the whole document in an `<article>` element by overriding `template`.
+
+```ruby
+class MyMarkdownArticle < Phlex::Markdown
+  def template
+    article(class: "prose") { super }
+  end
+end
+```
 
 ### Community 🙌
 

data/lib/phlex/markdown.rb

@@ -64,9 +64,11 @@ module Phlex
 			in :list_item
 				li { visit_children(node) }
 			in :code
-				code { text(node.string_content) }
+				inline_code do |**attributes|
+					code(**attributes) { text(node.string_content) }
+				end
 			in :code_block
-				code_block(node.string_content, language: node.fence_info) do |**attributes|
+				code_block(node.string_content, node.fence_info) do |**attributes|
 					pre(**attributes) do
 						code(class: "language-#{node.fence_info}") do
 							text(node.string_content)
@@ -80,8 +82,12 @@ module Phlex
 			end
 		end
 
-		def code_block(code, language:)
-			yield
+		def inline_code(**attributes)
+			yield(**attributes)
+		end
+
+		def code_block(code, language, **attributes)
+			yield(**attributes)
 		end
 
 		def visit_children(node)

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: phlex-markdown
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Joel Drapper
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-17 00:00:00.000000000 Z
+date: 2022-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: markly
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: phlex
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.5'
 description: A Markdown view for Phlex
 email:
 - joel@drapper.me