Rdoc Markup link format and add links where helpful.
@@ -21,8 +21,8 @@ function properly. libxml2, in turn, depends on:
If you are running Linux or Unix you'll need a C compiler so the
extension can be compiled when it is installed. If you are running
Windows, then install the x64-mingw32 gem or build it yourself using
-Devkit (http://rubyinstaller.org/add-ons/devkit/) or
-msys2 (https://msys2.github.io/).
+Devkit[http://rubyinstaller.org/add-ons/devkit/] or
+msys2[https://msys2.github.io/].
== Installation
The easiest way to install libxml-ruby is via RubyGems. To install:
@@ -39,7 +39,7 @@ on your <tt>PATH</tt>.
The gem also includes a Microsoft VC++ 2012 solution and XCode 5 project - these
are very useful for debugging.
-libxml-ruby's source codes lives on Github at https://github.com/xml4r/libxml-ruby.
+libxml-ruby's source codes lives on GitHub[https://github.com/xml4r/libxml-ruby].
== Getting Started
Using libxml is easy. First decide what parser you want to use:
@@ -72,14 +72,13 @@ This can be done using libxml's powerful set of validators:
* Relax Schemas (LibXML::XML::RelaxNG)
* XML Schema (LibXML::XML::Schema)
-Finally, if you'd like to use XSL Transformations to process data,
-then install the libxslt gem which is available at
-https://github.com/xml4r/libxslt-ruby.
+Finally, if you'd like to use XSL Transformations to process data, then install
+the {libxslt gem}[https://github.com/xml4r/libxslt-rubygem].
== Usage
-For information about using libxml-ruby please refer to its documentation at
-http://xml4r.github.com/libxml-ruby/rdoc/index.html. Some tutorials are also
-available at https://github.com/xml4r/libxml-ruby/wiki.
+For information about using libxml-ruby please refer to its
+documentation[http://xml4r.github.com/libxml-ruby/rdoc/index.html]. Some tutorials are also
+available[https://github.com/xml4r/libxml-ruby/wiki].
All libxml classes are in the LibXML::XML module. The easiest
way to use libxml is to <tt>require 'xml'</tt>. This will mixin
@@ -157,8 +156,9 @@ From https://svn.concord.org/svn/projects/trunk/common/ruby/xml_benchmarks/
Documentation is available via rdoc, and is installed automatically with the
gem.
-libxml-ruby's online documentation is generated using Hanna, which is a
-development gem dependency.
+libxml-ruby's {online
+documentation}[https://xml4r.github.io/libxml-ruby/rdoc/index.html] is generated
+using Hanna, which is a development gem dependency.
Note that older versions of Rdoc, which ship with Ruby 1.8.x, will report
a number of errors. To avoid them, install Rdoc 2.1 or higher. Once you have
@@ -168,8 +168,8 @@ includes. An easy way to do that is rename the directory
<tt>ruby/lib/ruby/1.8/rdoc_old</tt>.
== Support
-If you have any questions about using libxml-ruby, please report them to
-Git Hub at https://github.com/xml4r/libxml-ruby/issues
+If you have any questions about using libxml-ruby, please report an issue
+on GitHub[https://github.com/xml4r/libxml-ruby/issues].
== Memory Management
libxml-ruby automatically manages memory associated with the
