Skip to content

Commit

Permalink
Release 1.0.1
Browse files Browse the repository at this point in the history
Also, added a badge pointing to the version on RubyGems.

#36
  • Loading branch information
mkobit committed Mar 19, 2016
1 parent 08693f8 commit e284f36
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 5 deletions.
10 changes: 6 additions & 4 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ Paul Rayner <https://github.com/paulrayner[@paulrayner]>; Dan Allen <https://git
:toc: preamble
:toclevels: 1

image:https://badge.fury.io/rb/jekyll-asciidoc.svg["Gem Version", link="https://badge.fury.io/rb/jekyll-asciidoc"]

A plugin for http://jekyllrb.com[Jekyll] that converts http://asciidoc.org[AsciiDoc] files in your site source to HTML pages using http://asciidoctor.org[Asciidoctor].

== Overview
Expand Down Expand Up @@ -61,7 +63,7 @@ Without Bundler::
--
If you are not using Bundler for managing Jekyll then install gems manually

$ gem install jekyll-asciidoc
$ gem install jekyll-asciidoc

And then, add the `jekyll-asciidoc` gem to the list of gems for Jekyll to load in your site's [path]_{empty}_config.yml_ file:

Expand Down Expand Up @@ -108,7 +110,7 @@ You can use an empty front matter header, as shown above, or you can define all
You can now build your site using:

$ jekyll build

and preview it using:

$ jekyll serve
Expand All @@ -117,7 +119,7 @@ If you are using Bundler then use following commands to do the same

$ bundle exec jekyll build
$ bundle exec jekyll serve

IMPORTANT: If you use the `--safe` option, the AsciiDoc plugin will not be activated.
The `--safe` flag disables third-party plugins such as this one.

Expand Down Expand Up @@ -332,7 +334,7 @@ or your site configuration:
asciidoctor:
attributes:
- icons
- iconsdir=/images/icons
- iconsdir=/images/icons

Then, simply put the icon images that the page needs in the [path]_images/icons_ directory.

Expand Down
2 changes: 1 addition & 1 deletion lib/jekyll-asciidoc/version.rb
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
module Jekyll
module AsciiDoc
VERSION = '1.0.1.dev'
VERSION = '1.0.1'
end
end

0 comments on commit e284f36

Please sign in to comment.