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

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 858c4a292d4fb336ff93128c501aa237d13d50a3b5947b4fcb67420d1aebc7fd
4
- data.tar.gz: 523547279ede54438f37877bef76f7e4aaa3322131d1b08dcaf4b15e8ede1670
3
+ metadata.gz: b5fd5c5020d4fa1d36fcd1c88ba75dc8ea05650a57860a10de93538f8000f833
4
+ data.tar.gz: fd03a223847dbd7995de145c7df37b91456b2b1fc4d4431aad42ee5163befa0c
5
5
  SHA512:
6
- metadata.gz: f65188c5daf1f31e2ba133a2348fc913dab9985fbb678160adedf0d0a9e2eedaccacc000b9c1080876dc6fc1b45efc91a7933b398632304cdeab1146bd99a8e8
7
- data.tar.gz: fbde90e9a9c6ba21db48257520c1c32824fe9799b4376e0530cfb36bfba2b671a62ad0d735b62c5a4b96f4c1677b4a990ed691e10400074bd3a68ca8db6b76e2
6
+ metadata.gz: e4215a6b0633d70913d2062a064b453ec09f04f5c082b31c75d790c82b33dd047e407f5f6a92e9caa6d29bb3abce3e10b50adef428bacfd98e8e0957ac6a35e9
7
+ data.tar.gz: bfaf67015121dd9efb23ae85d32b4fe666ff98e2eb1525cfdf97acc89687f1c6bc0b579f871d990b879fad02f7e495d78da99ab50540f5c0c8c7712728f134e7
data/README.md CHANGED
@@ -105,14 +105,26 @@ providing further niceties.
105
105
 
106
106
  #### Syntax Highlighter Plugin
107
107
 
108
+ 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:
109
+
110
+ - `"base16-ocean.dark"`
111
+ - `"base16-eighties.dark"`
112
+ - `"base16-mocha.dark"`
113
+ - `"base16-ocean.light"`
114
+ - `"InspiredGitHub"`
115
+ - `"Solarized (dark)"`
116
+ - `"Solarized (light)"`
117
+
108
118
  ````ruby
109
119
  code = <<~CODE
110
120
  ```ruby
111
121
  def hello
112
- puts "hello"
122
+ puts "hello"
113
123
  end
124
+ ```
114
125
  CODE
115
126
 
127
+ # pass in a theme name from a pre-existing set
116
128
  puts Commonmarker.to_html(code, plugins: { syntax_highlighter: { theme: "InspiredGitHub" } })
117
129
 
118
130
  # <pre style="background-color:#ffffff;" lang="ruby"><code>
@@ -123,32 +135,49 @@ puts Commonmarker.to_html(code, plugins: { syntax_highlighter: { theme: "Inspire
123
135
  # </code></pre>
124
136
  ````
125
137
 
126
- To disable this plugin, pass `nil`:
138
+ By default, the plugin uses the `"base16-ocean.dark"` theme to syntax highlight code.
139
+
140
+ To disable this plugin, set the value to `nil`:
141
+
142
+ ````ruby
143
+ code = <<~CODE
144
+ ```ruby
145
+ def hello
146
+ puts "hello"
147
+ end
148
+ ```
149
+ CODE
127
150
 
128
- ```ruby
129
151
  Commonmarker.to_html(code, plugins: { syntax_highlighter: nil })
130
- # or
131
- Commonmarker.to_html(code, plugins: { syntax_highlighter: { theme: nil } })
132
- ```
133
152
 
134
- You can also provide a `path` to a directory containing `.tmtheme` files to load:
153
+ # <pre lang="ruby"><code>def hello
154
+ # puts &quot;hello&quot;
155
+ # end
156
+ # </code></pre>
157
+ ````
158
+
159
+ To output CSS classes instead of `style` attributes, set the `theme` key to `""`:
135
160
 
136
- ```ruby
161
+ ````ruby
162
+ code = <<~CODE
163
+ ```ruby
164
+ def hello
165
+ puts "hello"
166
+ end
167
+ CODE
137
168
 
138
- Commonmarker.to_html(code, plugins: { syntax_highlighter: { theme: "Monokai", path: "./themes" } })
139
- ```
169
+ Commonmarker.to_html(code, plugins: { syntax_highlighter: { theme: "" } })
140
170
 
141
- ##### Available themes
171
+ # <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>
172
+ # <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>
173
+ # <span class="keyword control ruby">end</span>\n</span></code></pre>
174
+ ````
142
175
 
143
- Here's [a list of themes available by default](https://docs.rs/syntect/5.0.0/syntect/highlighting/struct.ThemeSet.html#implementations):
176
+ To use a custom theme, you can provide a `path` to a directory containing `.tmtheme` files to load:
144
177
 
145
- - `"base16-ocean.dark"`
146
- - `"base16-eighties.dark"`
147
- - `"base16-mocha.dark"`
148
- - `"base16-ocean.light"`
149
- - `"InspiredGitHub"`
150
- - `"Solarized (dark)"`
151
- - `"Solarized (light)"`
178
+ ```ruby
179
+ Commonmarker.to_html(code, plugins: { syntax_highlighter: { theme: "Monokai", path: "./themes" } })
180
+ ```
152
181
 
153
182
  ## Output formats
154
183
 
@@ -26,7 +26,7 @@ module Commonmarker
26
26
  header_ids: "",
27
27
  footnotes: false,
28
28
  description_lists: false,
29
- front_matter_delimiter: nil,
29
+ front_matter_delimiter: "",
30
30
  shortcodes: true,
31
31
  },
32
32
  format: [:html].freeze,
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Commonmarker
4
- VERSION = "1.0.0.pre10"
4
+ VERSION = "1.0.0.pre12"
5
5
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: commonmarker
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.0.pre10
4
+ version: 1.0.0.pre12
5
5
  platform: x86_64-darwin
6
6
  authors:
7
7
  - Garen Torikian
@@ -9,7 +9,7 @@ authors:
9
9
  autorequire:
10
10
  bindir: exe
11
11
  cert_chain: []
12
- date: 2023-07-24 00:00:00.000000000 Z
12
+ date: 2023-12-07 00:00:00.000000000 Z
13
13
  dependencies:
14
14
  - !ruby/object:Gem::Dependency
15
15
  name: rake