README.adoc in asciidoctor-1.5.1 vs README.adoc in asciidoctor-1.5.2

- old
+ new

@@ -40,16 +40,15 @@ :uri-gitscm-repo: https://github.com/git/git-scm.com :uri-prototype: {uri-gitscm-repo}/commits/master/lib/asciidoc.rb :uri-freesoftware: https://www.gnu.org/philosophy/free-sw.html :uri-foundation: http://foundation.zurb.com :uri-tilt: https://github.com/rtomayko/tilt -:uri-ruby: https://ruby-lang.org // images: -:screenshot-img: screenshot.png +:image-uri-screenshot: https://raw.githubusercontent.com/asciidoctor/asciidoctor/master/screenshot.png {uri-project}[Asciidoctor] is a _fast_ text processor and publishing toolchain for converting {uri-what-is-asciidoc}[AsciiDoc] content to HTML5, DocBook 5 (or 4.5) and other formats. -Asciidoctor is written in {uri-ruby}[Ruby], packaged as a RubyGem and published to {uri-rubygem}[RubyGems.org]. +Asciidoctor is written in Ruby, packaged as a RubyGem and published to {uri-rubygem}[RubyGems.org]. The gem is also included in several Linux distributions, including Fedora, Debian and Ubuntu. Asciidoctor is open source, {uri-repo}[hosted on GitHub] and released under the MIT license. [TIP] ==== @@ -60,20 +59,31 @@ Asciidoctor also runs in JavaScript. We use http://opalrb.org[Opal] to transcompile the Ruby source to JavaScript to produce {uri-asciidoctorjs}[Asciidoctor.js], a fully-functional version of Asciidoctor that works in any JavaScript environment, such as a web browser or Node.js. Asciidoctor.js is used to power the AsciiDoc preview extensions for Chrome, Atom, Brackets and other web-based tooling. ==== +.Key documentation +[square] +* {uri-docs}/what-is-asciidoc[What is Asciidoc?] +* {uri-docs}/asciidoc-writers-guide[AsciiDoc Writer's Guide] +* {uri-docs}/asciidoc-syntax-quick-reference[AsciiDoc Syntax Reference] +* {uri-docs}/user-manual[Asciidoctor User Manual] + ifdef::env-github[] -*Project health:* image:http://img.shields.io/travis/asciidoctor/asciidoctor/master.svg[Build Status, link="https://travis-ci.org/asciidoctor/asciidoctor"] image:http://img.shields.io/coveralls/asciidoctor/asciidoctor/master.svg["Coverage Status", link="https://coveralls.io/r/asciidoctor/asciidoctor"] +.*Project Health* +image:http://img.shields.io/travis/asciidoctor/asciidoctor/master.svg[Build Status, link=https://travis-ci.org/asciidoctor/asciidoctor] +//image:http://img.shields.io/coveralls/asciidoctor/asciidoctor/master.svg[Coverage Status, link=https://coveralls.io/r/asciidoctor/asciidoctor] +image:https://codeclimate.com/github/asciidoctor/asciidoctor/badges/gpa.svg[Code Climate, link="https://codeclimate.com/github/asciidoctor/asciidoctor"] +image:http://inch-ci.org/github/asciidoctor/asciidoctor.svg?branch=master[Inline docs, link="http://inch-ci.org/github/asciidoctor/asciidoctor"] endif::env-github[] == The Big Picture Asciidoctor reads content written in plain text, as shown in the panel on the left in the image below, and converts it to HTML5, as shown rendered in the right panel. Asciidoctor adds a default stylesheet to the HTML5 document, as shown, to provide a pleasant out-of-the-box experience. -image::{screenshot-img}[Preview of AsciiDoc source and corresponding rendered HTML] +image::{image-uri-screenshot}[Preview of AsciiDoc source and corresponding rendered HTML] == AsciiDoc Processing Asciidoctor reads and parses text written in the AsciiDoc syntax, then feeds the parse tree into a set of built-in templates to produce HTML5, DocBook 5 (or 4.5). You have the option of writing your own converter or providing {uri-tilt}[Tilt]-supported templates to customize the generated output or produce alternative formats. @@ -84,11 +94,11 @@ In addition to the standard AsciiDoc syntax, Asciidoctor recognizes additional markup and formatting options, such as font-based icons (e.g., [x-]`icon:fire[]`) and UI elements (e.g., [x-]`button:[Save]`). Asciidoctor also offers a modern, responsive theme based on {uri-foundation}[Foundation] to style the HTML5 output. == Requirements -Asciidoctor works on Linux, OSX (Mac) and Windows and requires one of the following implementations of {uri-ruby}[Ruby]: +Asciidoctor works on Linux, OSX (Mac) and Windows and requires one of the following implementations of Ruby: * MRI (Ruby 1.8.7, 1.9.3, 2.0.0 & 2.1.2) * JRuby 1.7 (Ruby 1.8 and 1.9 modes) * Rubinius 2.2.x * Opal (JavaScript) @@ -327,9 +337,72 @@ The project was initiated in 2012 by https://github.com/erebor[Ryan Waldron] and based on {uri-prototype}[a prototype] written by https://github.com/nickh[Nick Hengeveld]. *AsciiDoc* was started by Stuart Rackham and has received contributions from many other individuals in the AsciiDoc community. == Changelog + +== 1.5.2 (2014-11-27) - @mojavelinux + +Enhancements:: + + * add docinfo extension (@mogztter) (#1162) + * allow docinfo to be in separate directory from content, specified by `docinfodir` attribute (@mogztter) (#511) + * enable TeX equation auto-numbering if `eqnums` attribute is set (@jxxcarlson) (#1110) + +Improvements:: + + * recognize `--` as valid line comment for callout numbers; make line comment configurable (#1068) + * upgrade highlight.js to version 8.4 (#1216) + * upgrade Font Awesome to version 4.2.0 (@clojens) (#1201) + * define JAVASCRIPT_PLATFORM constant to simplify conditional logic in the JavaScript environment (#897) + * provide access to destination directory, outfile and outdir via Document object (#1203) + * print encoding information in version report produced by `asciidoctor -v` (#1210) + * add intrinsic attribute named `cpp` with value `C++` (#1208) + * preserve URI targets passed to `stylesheet` and related attributes (#1192) + * allow numeric characters in block attribute name (#1103) + * support custom YouTube playlists (#1105) + * make start number for unique id generation configurable (#1148) + * normalize and force UTF-8 encoding of docinfo content (#831) + * allow subs and default_subs to be specified in Block constructor (#749) + * enhance error message when reading binary input files (@mogztter) (#1158) + * add `append` method as alias to `<<` method on AbstractBlock (#1085) + * assign value of `preface-title` as title of preface node (#1090) + * fix spacing around checkbox in checklist (#1138) + * automatically load Slim's include plugin when using slim templates (@jirutka) (#1151) + * mixin Slim helpers into execution scope of slim templates (@jirutka) (#1143) + * improve DocBook output for manpage doctype (@bk2204) (#1134, #1142) + +Compliance:: + + * substitute attribute entry value in attributes defined outside of header (#1130) + * allow empty cell to appear at end of table row (#1106) + * only produce one row for table in CSV or DSV format with a single cell (#1180) + +Bug fixes:: + + * add explicit to_s call to generate delimiter settings for MathJax config (#1198) + * fix includes that reference absolute Windows paths (#1144) + * apply DSL to extension block in a way compatible with Opal + +== 1.5.1 (2014-09-29) - @mojavelinux + +Bug fixes:: + + * recognize tag directives inside comments within XML files for including tagged regions + * restore passthroughs inside footnotes when more than one footnote appears on the same line + * -S flag in cli recognizes safe mode name as lowercase string + * do not match # in character reference when looking for marked text + * add namespace to lang attribute in DocBook 5 backend + * restore missing space before conum on last line of listing when highlighting with Pygments + * place conums on correct lines when line numbers are enabled when highlighting with Pygments + * don't expand mailto links in print styles + +Improvements:: + + * implement File.read in Node (JavaScript) environment + * assign sectnumlevels and toclevels values to maxdepth attribute on AsciiDoc processing instructions in DocBook output + * add test for usage of image block macro with data URI + * use badges from shields.io in README === 1.5.0 (2014-08-12) - @mojavelinux Performance::