anchor.diff:   ** generate an index page named `index.html` that contains links and some info about the converted files. The file is placed in the `my_dst_root/<branch_name` dir.
    * generate a summary page containing links to a all branches and place it in the `my_dst_root` dir.
   
  -=== Publish the asciidoctor.org documents with text search
  -
  -giblish can be used to generate html docs suitable for serving via a web server (e.g. Apache). You can use the cgi script included in the giblish gem to provide text search capabilities.
  -
  -Here is an example of how to publish the docs in the official asciidoctor.org git repo to a web server, including index pages and text search.
  -
  -NOTE: No consideration has been taken to how permissions are set up on the web server. Just running the below commands as-is on e.g.a standard apache set-up will bail out with 'permission denied' errors.
  -
  -==== Generating the html documents
  -
  -The example assumes that you have one machine where you generate the documents and another machine that runs a web server to which you have ssh access.
  -
  -The generated docs shall be accessible via _www.example.com/adocorg/with_search_
  -
  -You need to provide two pieces of deployment info to giblish when generating the documents:
  -
  - * the uri path where to access the deployed docs (/adocorg/with_search in this example)
  - * the path in the local file system on the web server where the search data can be accessed
  -   (/var/www/html/site_1/adocorg/with_search in this example)
  -
  -The following commands will generate the asciidoctor.org documentation and deploy the result to the web server.
  -
  - . Clone the asciidoctor doc repo to your development machine
  -+
  - git clone https://github.com/asciidoctor/asciidoctor.org.git
  -
  - . Generate the html documentation with the correct deployment info
  -+
  - giblish -j '^.*_include.*' -m -mp /var/www/html/site_1/adocorg/with_search -w /adocorg/with_search -g master --index-basename "myindex" asciidoctor.org/docs ./generated_docs
  -+
  -Explanation of the parameters and arguments::
  - * *pass:[-j '^.*_include.*']* - exclude everything in the __include_ directory. (the
  -                                 asciidoctor.org repo stores partial docs here).
  - * *-m* - assemble the necessary search data to support text search and include this data as part of
  -          the generated documents.
  - * *-mp /var/www/html/site_1/adocorg/with_search* - the file system path on the deployment machine where
  -                                                    the search data is located
  - * *-w /adocorg/with_search* - the uri path to the deployed docs
  - * *-g master* - publish all git branches that matches the regexp 'master' (i.e. only the 'master'
  -                 branch).
  - * *--index-basename "myindex"* - change the default name (index) that giblish uses for the generated
  -                                  index page. This is needed since asciidoctor.org contains an
  -                                  "index.adoc" file that would otherwise be overwritten by giblish.
  - * *asciidoctor.org/docs* - the root of the source document tree.
  - * *./generated_docs* - a temporary storage for the generated html docs on the local system.
  -+
  -
  - . Copy the generated files to the web server
  -
  - scp -r ./generated_docs rillbert@my.web.server.org:/var/www/adocorg/with_search/.
  -+
  -
  -
  -==== Copy the text search script to the web server
  -
  -This only needs to be done once (or if a new version of giblish breaks the currently used API).
  -
  -IMPORTANT: The current version of giblish expects the script to be found at the URI path `/cgi-bin/giblish-search.cgi`. This might be customizable in future versions but is currently hard-coded. Thus, if your web-server serves pages at www.mywebsite.com, the search script must be accessible at www.mywebsite.com/cgi-bin/giblish-search.cgi
  -
  - . Find the server side script that implements text search that is included with giblish
  -
  - gem which giblish
  -+
  -
  -In my case this returns `/var/lib/ruby/gems/2.4.0/gems/giblish-0.5.2/lib/giblish.rb`. This means that I will find the script in the same directory, i.e. `/var/lib/ruby/gems/2.4.0/gems/giblish-0.5.2/lib`.
  -
  - . Copy the server side script to the /cgi-bin dir on the web server. In this example the cgi-bin dir is configured to be `/var/www/cgi-bin`
  -+
  - scp /var/lib/ruby/gems/2.4.0/gems/giblish-0.5.2/lib/giblish-search.cgi rillbert@my.web.server.org:/var/www/cgi-bin/giblish-search.cgi
  +// === Publish the asciidoctor.org documents with text search
  +
  +// giblish can be used to generate html docs suitable for serving via a web server (e.g. Apache). You can use the cgi script included in the giblish gem to provide text search capabilities.
  +
  +// Here is an example of how to publish the docs in the official asciidoctor.org git repo to a web server, including index pages and text search.
  +
  +// NOTE: No consideration has been taken to how permissions are set up on the web server. Just running the below commands as-is on e.g.a standard apache set-up will bail out with 'permission denied' errors.
  +
  +// ==== Generating the html documents
  +
  +// The example assumes that you have one machine where you generate the documents and another machine that runs a web server to which you have ssh access.
  +
  +// The generated docs shall be accessible via _www.example.com/adocorg/with_search_
  +
  +// You need to provide two pieces of deployment info to giblish when generating the documents:
  +
  +//  * the uri path where to access the deployed docs (/adocorg/with_search in this example)
  +//  * the path in the local file system on the web server where the search data can be accessed
  +//    (/var/www/html/site_1/adocorg/with_search in this example)
  +
  +// The following commands will generate the asciidoctor.org documentation and deploy the result to the web server.
  +
  +//  . Clone the asciidoctor doc repo to your development machine
  +// +
  +//  git clone https://github.com/asciidoctor/asciidoctor.org.git
  +
  +//  . Generate the html documentation with the correct deployment info
  +// +
  +//  giblish -j '^.*_include.*' -m -mp /var/www/html/site_1/adocorg/with_search -w /adocorg/with_search -g master --index-basename "myindex" asciidoctor.org/docs ./generated_docs
  +// +
  +// Explanation of the parameters and arguments::
  +//  * *pass:[-j '^.*_include.*']* - exclude everything in the __include_ directory. (the
  +//                                  asciidoctor.org repo stores partial docs here).
  +//  * *-m* - assemble the necessary search data to support text search and include this data as part of
  +//           the generated documents.
  +//  * *-mp /var/www/html/site_1/adocorg/with_search* - the file system path on the deployment machine where
  +//                                                     the search data is located
  +//  * *-w /adocorg/with_search* - the uri path to the deployed docs
  +//  * *-g master* - publish all git branches that matches the regexp 'master' (i.e. only the 'master'
  +//                  branch).
  +//  * *--index-basename "myindex"* - change the default name (index) that giblish uses for the generated
  +//                                   index page. This is needed since asciidoctor.org contains an
  +//                                   "index.adoc" file that would otherwise be overwritten by giblish.
  +//  * *asciidoctor.org/docs* - the root of the source document tree.
  +//  * *./generated_docs* - a temporary storage for the generated html docs on the local system.
  +// +
  +
  +//  . Copy the generated files to the web server
  +
  +//  scp -r ./generated_docs rillbert@my.web.server.org:/var/www/adocorg/with_search/.
  +// +
  +
  +
  +// ==== Copy the text search script to the web server
  +
  +// This only needs to be done once (or if a new version of giblish breaks the currently used API).
  +
  +// IMPORTANT: The current version of giblish expects the script to be found at the URI path `/cgi-bin/giblish-search.cgi`. This might be customizable in future versions but is currently hard-coded. Thus, if your web-server serves pages at www.mywebsite.com, the search script must be accessible at www.mywebsite.com/cgi-bin/giblish-search.cgi
  +
  +//  . Find the server side script that implements text search that is included with giblish
  +
  +//  gem which giblish
  +// +
  +
  +// In my case this returns `/var/lib/ruby/gems/2.4.0/gems/giblish-0.5.2/lib/giblish.rb`. This means that I will find the script in the same directory, i.e. `/var/lib/ruby/gems/2.4.0/gems/giblish-0.5.2/lib`.
  +
  +//  . Copy the server side script to the /cgi-bin dir on the web server. In this example the cgi-bin dir is configured to be `/var/www/cgi-bin`
  +// +
  +//  scp /var/lib/ruby/gems/2.4.0/gems/giblish-0.5.2/lib/giblish-search.cgi rillbert@my.web.server.org:/var/www/cgi-bin/giblish-search.cgi
  
positive.code: The features of giblish include:
  
   * An index page listing all rendered documents with clickable links.
   * A (stripped-down but nonetheless useful) text-search of your (html) documents (requires that you view your docs via a web-server.
   * If the source directory tree is part of a git repository, giblish can generate separate html/pdf trees for branches and/or tags that match a user specified regexp (see examples below).
   * Document ids - Note: the implementation of this is giblish-specific and thus you need to render your adoc files using giblish to make this work as intended. You can use document ids to:
   ** Reference one doc in the source tree from another doc without depending on file names or relative paths. The referenced doc can thus be moved within the source tree or change its file name and the reference will still be valid.
   ** Validate doc id references during document rendering and thus be alerted to any invalid doc id references.
   ** Let giblish generate a clickable graph of all document references (requires graphviz and the 'dot' tool).
  
  == Dependencies and credits
  
  
negative.code: 
  == Installation
  
   gem install giblish
  
  Want to get started straight away? Go directly to the <<usage_examples>>.
  
  === Some caveats
  
  