Skip to content

Commit f278e09

Browse files
committed
Added info to gemspec.
Added instructions on running conversion with stylesheet to README.md
1 parent 2b48d7b commit f278e09

2 files changed

Lines changed: 10 additions & 1 deletion

File tree

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,14 @@ The callout attaches a class called `external-callout-block` to each source list
113113

114114
The extension also adds a class called `external-callout-list` to the list of definitions at the bottom of the source block. (There's probably no need to adjust the styling for this.)
115115

116+
Then to convert a document with a stylesheet, use something like this:
117+
118+
```ruby
119+
Asciidoctor.convert_file File.join(File.dirname(__FILE__), 'sample.adoc'),
120+
safe: :unsafe, backend: :html5,
121+
attributes: {'stylesheet' => './callout.css'}
122+
```
123+
116124
## Development
117125

118126
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

asciidoctor-external-callout.gemspec

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@ Gem::Specification.new do |spec|
99
spec.email = ["clogs-wrench-0z@icloud.com"]
1010

1111
spec.summary = "Asciidoc extension for adding callouts without marking up the source listing block."
12-
# spec.description = "TODO: Write a longer description or delete this line."
12+
spec.description = "If you can't add callout markers to your source listing" \
13+
"(if you need to keep a shell script runnable for example), then use this."
1314
spec.homepage = "https://github.com/RayOffiah/asciidoctor-external-callout-ruby"
1415
spec.license = "MIT"
1516
spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")

0 commit comments

Comments
 (0)