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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8822c5d66ddd75bb8eef083a1a865b7bb017f63c0d96bd451a2abb2ea1fb289
-  data.tar.gz: 357e39823b8c4af6389f68695a74a453e3cd269da9209d2846ec1650941c94a3
+  metadata.gz: 523218a2e8ab4401029a56b9f76943125f7fe05cce438f2f3d4d1f2abf6a9563
+  data.tar.gz: 63c4aea672a42c40a5b4bb6e9645ab65d6752e8a8fd1c845b2df8784b2c012e7
 SHA512:
-  metadata.gz: 6d36a955109e13c1ee51cde8cdc67a2e79ad6c2c39ab753b13063668b389a052e7f272b434c8158e93ca2b946cd5f48d3ae27a07b0f6b8b6bd1cc18dfb7cf5ca
-  data.tar.gz: f7d51a0383cdb126bd12204f5efb77d52caf342cdd3c4285643dceb360f56e69e405d443977f3123f45d1f193b6f25eacbbe90775c8c1369d5b6884ff196d4b2
+  metadata.gz: fa29ef1ff55a4b7529d7a8376584beac177ad30006f25d64cb1ae254f9517fabc5d621baef5a837354c8b368e18b44456722fd05ac32c9ec768ae3a53998161f
+  data.tar.gz: 07f2d1013ba8142b59cd3f3b1847b7c3ef67e6dac6f7fe20dc0022a8404dd3fa775596e50fe07847cb5ca3166a750fa9bcf55ab9c92bf36535bc342efe8a67d4

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: arm64-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