The following project contains ascii doc source for CDI book. In this document you’ll find information about contributing to this book and render it in html
This book is written in asciidoc with Asciidoctor toolchain. As asciidoctor requiers Ruby, the first will be to install Ruby. If you don’t know how to this, you can follow instruction on the Ruby site
Once this done you’ll have to follow the steps below to work on the book
Install Bundler:
gem install bundler
Then run:
bundle install
Install Graphviz and have the dot
executable in the path.
To generate the HTML presentation, run the following command:
asciidoctor -r asciidoctor-diagram -a data-uri book.adoc
With Guard and LiveReload, you can change the content of the doc and have the files automatically generated and your browser updated.
To start, make sure that you have all the needed gems installed:
bundle update
Then install the LiveReload plugin for your browser (Chrome, Firefox and Safari are supported).
Finally, launch Guard:
bundle exec guard
Browse to the generated file you want to refresh and activate the LiveReload plugin (don’t forget to configure the plugin to accept refreshing local files).
The content of this project is licensed under the Creative Commons Attribution 4.0 license, and the underlying source code used for the examples is licensed under the MIT license.