commonmarker 1.0.0.pre6-x86_64-linux → 1.0.0.pre8-x86_64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a0114dc7e579a1819012a390ad7bc93303d53ac4d276e3b5c47543fd52c57a0
-  data.tar.gz: 3623268197b24a490b47189facc04a61826392ae566aaac8169e7596feab9780
+  metadata.gz: f40ed149245b11547406ca327cb2c1e7c8750b772563b4844815ddba38cb2ac4
+  data.tar.gz: 587707e21e7596e8d3679cca3c66d898e3b35674aff538cae92d7775a513e009
 SHA512:
-  metadata.gz: 8aeeae75f6283a0ae8d5dbce7680d46a9379732f25e420f463cf3f3431d58e9413a00d3bfd9e05a99427bc1398632e8b817267f3f43d47bc601ada2deea29efd
-  data.tar.gz: 7492d77e0e0271e63ce1519a990ec87aac228e9256375ce008f83922ec8d6b319d26e4725ccf8573e9d1ed0353cef40f3007cc1abe9029ea471a918e5fd879e7
+  metadata.gz: 7258acdca3aee0b92e8872a2a0cbd156dc5933db74706ce972824041b87f1b16493fb0968771527ef3904111aaaf0502d890d07e89580a0649b698aae8387968
+  data.tar.gz: 3d18e4d88effe9906c2dd4817c904702151a7c2f0cb81969ce602fe941cf5e61a3cfe03bf6c97f46670bfb3ebd6f6ac32356f333714963d28c6cf6229035ebcd

data/README.md

@@ -7,7 +7,7 @@ Ruby wrapper for Rust's [comrak](https://github.com/kivikakk/comrak) crate.
 
 It passes all of the CommonMark test suite, and is therefore spec-complete. It also includes extensions to the CommonMark spec as documented in the [GitHub Flavored Markdown spec](http://github.github.com/gfm/), such as support for tables, strikethroughs, and autolinking.
 
-For more information on available extensions, see [the documentation below](#extensions).
+For more information on available extensions, see [the documentation below](#extension-options).
 
 ## Installation
 
@@ -27,7 +27,7 @@ Or install it yourself as:
 
 ### Converting to HTML
 
-Call `render_html` on a string to convert it to HTML:
+Call `to_html` on a string to convert it to HTML:
 
 ```ruby
 require 'commonmarker'
@@ -68,14 +68,14 @@ Note that there is a distinction in comrak for "parse" options and "render" opti
 | `hardbreaks`      | [Soft line breaks](http://spec.commonmark.org/0.27/#soft-line-breaks) translate into hard line breaks. | `true`  |
 | `github_pre_lang` | GitHub-style `<pre lang="xyz">` is used for fenced code blocks with info tags.                         | `true`  |
 | `width`           | The wrap column when outputting CommonMark.                                                            | `80`    |
-| `unsafe_`         | Allow rendering of raw HTML and potentially dangerous links.                                           | `false` |
+| `unsafe`          | Allow rendering of raw HTML and potentially dangerous links.                                           | `false` |
 | `escape`          | Escape raw HTML instead of clobbering it.                                                              | `false` |
 
 As well, there are several extensions which you can toggle in the same manner:
 
 ```ruby
 Commonmarker.to_html('"Hi *there*"', options: {
-    extensions: { footnotes: true, description_lists: true },
+    extension: { footnotes: true, description_lists: true },
     render: { hardbreaks: false}
 })
 ```
@@ -92,34 +92,38 @@ Commonmarker.to_html('"Hi *there*"', options: {
 | `superscript`            | Enables the superscript Comrak extension.                                                                           | `false` |
 | `header_ids`             | Enables the header IDs Comrak extension. from the GFM spec.                                                         | `""`    |
 | `footnotes`              | Enables the footnotes extension per `cmark-gfm`.                                                                    | `false` |
-| `description_lists`      | Enables the description lists extension..                                                                           | `false` |
+| `description_lists`      | Enables the description lists extension.                                                                            | `false` |
 | `front_matter_delimiter` | Enables the front matter extension.                                                                                 | `""`    |
+| `shortcodes`             | Enables the shortcodes extension.                                                                                   | `true`  |
 
 For more information on these options, see [the comrak documentation](https://github.com/kivikakk/comrak#usage).
 
 ### Plugins
 
 In addition to the possibilities provided by generic CommonMark rendering, Commonmarker also supports plugins as a means of
-providing further niceties. For example:
+providing further niceties.
 
-    code = <<~CODE
-        ```ruby
-        def hello
-        puts "hello"
-        end
+#### Syntax Highlighter Plugin
 
-        CODE
+````ruby
+code = <<~CODE
+  ```ruby
+  def hello
+  puts "hello"
+  end
+CODE
 
-    Commonmarker.to_html(code, plugins: { syntax_highlighter: { theme: "Inspired GitHub" } })
+puts Commonmarker.to_html(code, plugins: { syntax_highlighter: { theme: "InspiredGitHub" } })
 
-    # <pre style="background-color:#ffffff;" lang="ruby"><code>
-    # <span style="font-weight:bold;color:#a71d5d;">def </span><span style="font-weight:bold;color:#795da3;">hello
-    # </span><span style="color:#323232;"> </span><span style="color:#62a35c;">puts </span><span style="color:#183691;">&quot;hello&quot;
-    # </span><span style="font-weight:bold;color:#a71d5d;">end
-    # </span>
-    # </code></pre>
+# <pre style="background-color:#ffffff;" lang="ruby"><code>
+# <span style="font-weight:bold;color:#a71d5d;">def </span><span style="font-weight:bold;color:#795da3;">hello
+# </span><span style="color:#62a35c;">puts </span><span style="color:#183691;">&quot;hello&quot;
+# </span><span style="font-weight:bold;color:#a71d5d;">end
+# </span>
+# </code></pre>
+````
 
-You can disable plugins just the same as with options, by passing `nil`:
+To disable this plugin, pass `nil`:
 
 ```ruby
 Commonmarker.to_html(code, plugins: { syntax_highlighter: nil })
@@ -127,6 +131,25 @@ Commonmarker.to_html(code, plugins: { syntax_highlighter: nil })
 Commonmarker.to_html(code, plugins: { syntax_highlighter: { theme: nil } })
 ```
 
+You can also provide a `path` to a directory containing `.tmtheme` files to load:
+
+```ruby
+
+Commonmarker.to_html(code, plugins: { syntax_highlighter: { theme: "Monokai", path: "./themes" } })
+```
+
+##### Available themes
+
+Here's [a list of themes available by default](https://docs.rs/syntect/5.0.0/syntect/highlighting/struct.ThemeSet.html#implementations):
+
+- `"base16-ocean.dark"`
+- `"base16-eighties.dark"`
+- `"base16-mocha.dark"`
+- `"base16-ocean.light"`
+- `"InspiredGitHub"`
+- `"Solarized (dark)"`
+- `"Solarized (light)"`
+
 ## Output formats
 
 Commonmarker can currently only generate output in one format: HTML.

data/lib/commonmarker/config.rb

@@ -13,7 +13,7 @@ module Commonmarker
         hardbreaks: true,
         github_pre_lang: true,
         width: 80,
-        unsafe_: false,
+        unsafe: false,
         escape: false,
       }.freeze,
       extension: {
@@ -27,6 +27,7 @@ module Commonmarker
         footnotes: false,
         description_lists: false,
         front_matter_delimiter: nil,
+        shortcodes: true,
       },
       format: [:html].freeze,
     }.freeze
@@ -34,6 +35,7 @@ module Commonmarker
     PLUGINS = {
       syntax_highlighter: {
         theme: "base16-ocean.dark",
+        path: "",
       },
     }
 

data/lib/commonmarker/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: commonmarker
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre6
+  version: 1.0.0.pre8
 platform: x86_64-linux
 authors:
 - Garen Torikian
@@ -9,23 +9,8 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-01-09 00:00:00.000000000 Z
+date: 2023-03-09 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: rb_sys
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  force_ruby_platform: false
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -54,20 +39,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
-- !ruby/object:Gem::Dependency
-  name: rake-compiler-dock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
 description: A fast, safe, extensible parser for CommonMark. This wraps the comrak
   Rust crate.
 email: 
@@ -75,18 +46,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- Cargo.lock
 - LICENSE.txt
 - README.md
-- commonmarker.gemspec
-- ext/commonmarker/Cargo.toml
 - ext/commonmarker/_util.rb
-- ext/commonmarker/extconf.rb
-- ext/commonmarker/src/lib.rs
-- ext/commonmarker/src/options.rs
-- ext/commonmarker/src/plugins.rs
-- ext/commonmarker/src/plugins/syntax_highlighting.rs
-- ext/commonmarker/src/utils.rs
 - lib/commonmarker.rb
 - lib/commonmarker/3.1/commonmarker.so
 - lib/commonmarker/3.2/commonmarker.so
@@ -122,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 3.3.22
 requirements: []
-rubygems_version: 3.4.3
+rubygems_version: 3.4.4
 signing_key: 
 specification_version: 4
 summary: CommonMark parser and renderer. Written in Rust, wrapped in Ruby.