Skip to content

Commit c594b66

Browse files
committed
Improve documents of SyntaxHighlightFilter
1 parent dc42b12 commit c594b66

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

lib/html/pipeline/syntax_highlight_filter.rb

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,15 @@
44

55
module HTML
66
class Pipeline
7-
# HTML Filter that syntax highlights code blocks wrapped
8-
# in <pre lang="...">.
7+
# HTML Filter that syntax highlights text inside code blocks.
8+
#
9+
# Context options:
10+
#
11+
# :highlight => String represents the language to pick lexer. Defaults to empty string.
12+
# :scope => String represents the class attribute adds to pre element after.
13+
# Defaults to "highlight highlight-css" if highlights a css code block.
14+
#
15+
# This filter does not write any additional information to the context hash.
916
class SyntaxHighlightFilter < Filter
1017
def initialize(*args)
1118
super(*args)

0 commit comments

Comments
 (0)