blob: ef5981001472f70e16b78a22680258148d8e51bf (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
|
= Tree Processor Extension Example
:navtitle: Tree Processor
Purpose::
Detect literal blocks that contain shell commands, strip the prompt character and style the command using CSS in such a way that the prompt character cannot be selected (as seen on help.github.com).
== sample-with-shell-session.adoc
[source,asciidoc]
----
$ echo "Hello, World!"
> Hello, World!
$ gem install asciidoctor
----
== ShellSessionTreeProcessor
[source,ruby]
----
class ShellSessionTreeProcessor < Asciidoctor::Extensions::TreeProcessor
LF = ?\n
def process document
(document.find_by(context: :literal) {|candidate| candidate.lines[0].start_with? '$ ', '> ' }).each do |block|
(children = block.parent.blocks)[children.index block] = convert_to_terminal_listing block
end
nil
end
def convert_to_terminal_listing block
attrs = block.attributes
attrs['role'] = 'terminal'
prompt_attr = (attrs.key? 'prompt') ? %( data-prompt="#{block.sub_specialchars attrs['prompt']}") : nil
lines = (block.content.split LF).map do |line|
if line.start_with? '$ '
%(<span class="command"#{prompt_attr}>#{line[2..-1]}</span>)
elsif line.start_with? '> '
%(<span class="output">#{line[5..-1]}</span>)
#%(<span class="output"><span class="comment-prefix"># </span>#{line[5..-1]}</span>)
else
line
end
end
create_listing_block block.parent, lines * LF, attrs, subs: nil
end
end
----
== Usage
[source,ruby]
----
Asciidoctor::Extensions.register do
tree_processor ShellSessionTreeProcessor
end
Asciidoctor.convert_file 'sample-with-shell-session.adoc', safe: :safe
----
|
