README.adoc in asciidoctor-epub3-1.5.0.alpha.14 vs README.adoc in asciidoctor-epub3-1.5.0.alpha.15
- old
+ new
@@ -1,8 +1,8 @@
= {project-name}: A _native_ EPUB3 converter for AsciiDoc
Dan Allen <https://github.com/mojavelinux[@mojavelinux]>; Sarah White <https://github.com/graphitefriction[@graphitefriction]>
-v1.5.0.alpha.14, 2020-02-29
+v1.5.0.alpha.15, 2020-03-11
// Settings:
:experimental:
:idprefix:
:idseparator: -
:imagesdir: data/samples/images
@@ -48,11 +48,10 @@
:uri-epubreadingsystem: http://www.idpf.org/epub/301/spec/epub-contentdocs.html#app-epubReadingSystem
:uri-android-sdk: http://developer.android.com/sdk/index.html
ifdef::status[]
image:https://img.shields.io/gem/v/asciidoctor-epub3.svg[Latest Release,link={uri-gem}]
-image:https://img.shields.io/badge/license-MIT-blue.svg[MIT License,link=#copyright]
image:{uri-repo}/workflows/CI/badge.svg[GitHub Actions,link={uri-ci}]
endif::[]
{project-name} is a set of Asciidoctor extensions for converting AsciiDoc documents directly to the EPUB3 and KF8/MOBI e-book formats.
@@ -101,11 +100,11 @@
* Highly-aesthetic and readable styles with optimized text legibility
* Respects font settings (if supported by the e-reader) without altering headings, code or icons
* EPUB3 metadata, manifest and spine (assembled by Gepub)
* Document metadata (title, authors, subject, keywords, etc.)
* Internal cross reference links
-* Syntax highlighting with CodeRay or Pygments (must use inline styles)
+* Syntax highlighting with Rouge, CodeRay or Pygments
* Unicode callout numbers
* Page breaks avoided in block content (so much as it's supported by the e-reader)
* Orphan section titles avoided (so much as it's supported by the e-reader)
* Table border settings honored
* Support for SVG images in the content
@@ -158,11 +157,10 @@
----
= Book Title
Author Name
:doctype: book
:imagesdir: images
-\ifndef::ebook-format[:leveloffset: 1]
//...and so on
== Chapter One
Some interesting text here.
@@ -196,30 +194,32 @@
$ NOKOGIRI_USE_SYSTEM_LIBRARIES=1 gem install asciidoctor-epub3 --pre
This optional environment variable tells the gem installer to link against the C libraries on the system, if available, instead of compiling the libraries from scratch.
This speeds up the installation of Nokogiri considerably.
-If you want to syntax highlight source listings, you'll also want to install CodeRay or Pygments.
+If you want to syntax highlight source listings, you'll also want to install Rouge, CodeRay or Pygments.
Choose one (or more) of the following:
+.Rouge
+ $ gem install rouge
+
.CodeRay
$ gem install coderay
.Pygments
$ gem install pygments.rb
-You then activate syntax highlighting for a given document by adding the `source-highlighter` attribute to the document header (CodeRay shown):
+You then activate syntax highlighting for a given document by adding the `source-highlighter` attribute to the document header (Rouge shown):
[source,asciidoc]
----
-:source-highlighter: coderay
+:source-highlighter: rouge
----
-NOTE: At the moment, Pygments is automatically used if it's available.
-If a style is not specified, the black and white theme (i.e., bw) is used.
-This default is used so that the syntax highlighting is legibile regardless of which reading mode the reader selects (white, black, sepia, etc).
-To override this default, you must pass a valid Pygments style name to the `pygments-style` attribute when invoking the `asciidoctor-epub3` script (e.g., `-a pygments-style=pastie`).
+NOTE: If a style is not specified, the black and white theme (i.e., bw) is used.
+This default is used so that the syntax highlighting is legible regardless of which reading mode the reader selects (white, black, sepia, etc).
+To override this default, you must set `<highlighter>-style` document header attribute to a valid highlighter style name (e.g., `:rouge-style: pastie`).
Assuming all the required gems install properly, verify you can run the `asciidoctor-epub3` script:
$ asciidoctor-epub3 -v
@@ -296,10 +296,14 @@
|epub-properties
|An optional override of the properties attribute for this document's item in the manifest.
_Only applies to a chapter document._
+|series-name, series-volume, series-id
+|Populates the series statements (`belongs-to-collection`) in the package metadata.
+Volume is a number, ID probably a UUID that is constant for all volumes in the series.
+
|epub3-frontmatterdir
|The path to a directory that contains frontmatter files. The file names must match `front-matter*.html` and will be included in alphabetic order. The files are expected to be valid EPUB HTML files. _If only one front matter page is
required, the default 'front-matter.html' file can be used instead._
|epub3-stylesdir
@@ -883,10 +887,10 @@
== Copyright
Copyright (C) 2014-2019 OpenDevise Inc. and the Asciidoctor Project.
Free use of this software is granted under the terms of the MIT License.
-For the full text of the license, see the <<LICENSE#,LICENSE>> file.
+For the full text of the license, see the link:LICENSE[] file.
Refer to the <<NOTICE#,NOTICE>> file for information about third-party Open Source software in use.
////
== Additional Points of Note