Code Monkey home page Code Monkey logo

cdi-book's Introduction

CDI Book

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

Build environment

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.

Build instructions

To generate the HTML presentation, run the following command:

asciidoctor -r asciidoctor-diagram  -a data-uri book.adoc

Use Guard and LiveReload

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).

License

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.

cdi-book's People

Contributors

antoinesd avatar josepaumard avatar

Watchers

 avatar  avatar  avatar  avatar

cdi-book's Issues

Image not found or not readable

Hi @antoinesd ,

I have followed the instructions given to generate the HTML presentation of this book.
Though the HTML is created, there is a problem with the generation of the image.

Execution of asciidoctor -r asciidoctor-diagram -a data-uri book.adoc causing error:
asciidoctor: WARNING: image to embed not found or not readable: C:/Workspaces/Worksapce-CDI/cdi-book/manuscript/../../images/jsr_lifecycle.png

asciidoc

cdi-book

Environment Details:
OS: Windows 10
Ruby: v2.4.4
Graphviz: v2.38

Also, Currently the book is incomplete from chapter#4 onward. Do you have plans to complete all the chapters of this book?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.