commonmarker 1.0.0.pre11-x86_64-darwin → 1.0.0.pre12-x86_64-darwin

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70a4bb7ec5741fc95923e2a5ebe58cadf2e9a02928ae94c0fffe3b5ca12573e6
-  data.tar.gz: d07cb54f48606624527b6853b24e2e4e8923d0f63065730989468ffd24a6dc4a
+  metadata.gz: b5fd5c5020d4fa1d36fcd1c88ba75dc8ea05650a57860a10de93538f8000f833
+  data.tar.gz: fd03a223847dbd7995de145c7df37b91456b2b1fc4d4431aad42ee5163befa0c
 SHA512:
-  metadata.gz: 5870196b206de742b66c269cab55f7573bbb070379e3fe5b6356f39be490b08a7ac665d93bc787a69f5afab5c17dd306830a3f109246ac4082afbca8c27e62d8
-  data.tar.gz: 863671a2572524e3ee41ec60ad7906d216ed27f5b918fc9031c6c5f7a845eb94e6099dbc792f55dd565f3cbaca4e60dfce18ec34287590d2594a0f3bfe82a003
+  metadata.gz: e4215a6b0633d70913d2062a064b453ec09f04f5c082b31c75d790c82b33dd047e407f5f6a92e9caa6d29bb3abce3e10b50adef428bacfd98e8e0957ac6a35e9
+  data.tar.gz: bfaf67015121dd9efb23ae85d32b4fe666ff98e2eb1525cfdf97acc89687f1c6bc0b579f871d990b879fad02f7e495d78da99ab50540f5c0c8c7712728f134e7

data/README.md

@@ -105,14 +105,26 @@ providing further niceties.
 
 #### Syntax Highlighter Plugin
 
+The library comes with [a set of pre-existing themes](https://docs.rs/syntect/5.0.0/syntect/highlighting/struct.ThemeSet.html#implementations) for highlighting code:
+
+- `"base16-ocean.dark"`
+- `"base16-eighties.dark"`
+- `"base16-mocha.dark"`
+- `"base16-ocean.light"`
+- `"InspiredGitHub"`
+- `"Solarized (dark)"`
+- `"Solarized (light)"`
+
 ````ruby
 code = <<~CODE
   ```ruby
   def hello
-  puts "hello"
+    puts "hello"
   end
+  ```
 CODE
 
+# pass in a theme name from a pre-existing set
 puts Commonmarker.to_html(code, plugins: { syntax_highlighter: { theme: "InspiredGitHub" } })
 
 # <pre style="background-color:#ffffff;" lang="ruby"><code>
@@ -123,32 +135,49 @@ puts Commonmarker.to_html(code, plugins: { syntax_highlighter: { theme: "Inspire
 # </code></pre>
 ````
 
-To disable this plugin, pass `nil`:
+By default, the plugin uses the `"base16-ocean.dark"` theme to syntax highlight code.
+
+To disable this plugin, set the value to `nil`:
+
+````ruby
+code = <<~CODE
+  ```ruby
+  def hello
+    puts "hello"
+  end
+  ```
+CODE
 
-```ruby
 Commonmarker.to_html(code, plugins: { syntax_highlighter: nil })
-# or
-Commonmarker.to_html(code, plugins: { syntax_highlighter: { theme: nil } })
-```
 
-You can also provide a `path` to a directory containing `.tmtheme` files to load:
+# <pre lang="ruby"><code>def hello
+#   puts &quot;hello&quot;
+# end
+# </code></pre>
+````
+
+To output CSS classes instead of `style` attributes, set the `theme` key to `""`:
 
-```ruby
+````ruby
+code = <<~CODE
+  ```ruby
+  def hello
+    puts "hello"
+  end
+CODE
 
-Commonmarker.to_html(code, plugins: { syntax_highlighter: { theme: "Monokai", path: "./themes" } })
-```
+Commonmarker.to_html(code, plugins: { syntax_highlighter: { theme: "" } })
 
-##### Available themes
+# <pre class="syntax-highlighting"><code><span class="source ruby"><span class="meta function ruby"><span class="keyword control def ruby">def</span></span><span class="meta function ruby"> # <span class="entity name function ruby">hello</span></span>
+#   <span class="support function builtin ruby">puts</span> <span class="string quoted double ruby"><span class="punctuation definition string begin ruby">&quot;</span>hello<span class="punctuation definition string end ruby">&quot;</span></span>
+# <span class="keyword control ruby">end</span>\n</span></code></pre>
+````
 
-Here's [a list of themes available by default](https://docs.rs/syntect/5.0.0/syntect/highlighting/struct.ThemeSet.html#implementations):
+To use a custom theme, you can provide a `path` to a directory containing `.tmtheme` files to load:
 
-- `"base16-ocean.dark"`
-- `"base16-eighties.dark"`
-- `"base16-mocha.dark"`
-- `"base16-ocean.light"`
-- `"InspiredGitHub"`
-- `"Solarized (dark)"`
-- `"Solarized (light)"`
+```ruby
+Commonmarker.to_html(code, plugins: { syntax_highlighter: { theme: "Monokai", path: "./themes" } })
+```
 
 ## Output formats
 

data/lib/commonmarker/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Commonmarker
-  VERSION = "1.0.0.pre11"
+  VERSION = "1.0.0.pre12"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: commonmarker
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre11
+  version: 1.0.0.pre12
 platform: x86_64-darwin
 authors:
 - Garen Torikian
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-10-12 00:00:00.000000000 Z
+date: 2023-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake