documentation/introduction.adoc in hyla-1.0.3 vs documentation/introduction.adoc in hyla-1.0.4

- old
+ new

@@ -48,10 +48,14 @@ - http://feedback.livereload.com/knowledgebase/articles/86242-how-do-i-install-and-use-the-browser-extensions-[How do I install and use the browser extensions for LiveReload]. Be sure to enable the option “Allow access to file URLs” checkbox in Tools > Extensions > LiveReload after installation of Chrome Extension. image::image/access_local_file.png[Access Local File,650,150] +== Dependencies + +- https://github.com/hakimel/reveal.js[RevealJS] - Version 2.6.1 + == Installation Use `gem install` command to deploy Hyla : $ gem install hyla -y -v 1.0.x @@ -134,17 +138,17 @@ rm -rf MyBlankProject/ hyla new --blank MyBlankProject --force - Create Asciidoc files from samples (book, article, image, audio, ...) - hyla create --t asciidoc -a article -d ~/hyla/MyBlankProject - hyla create --t asciidoc -a book -d ~/hyla/MyBlankProject - hyla create --t asciidoc -a image -d ~/hyla/MyBlankProject - hyla create --t asciidoc -a audio -d ~/hyla/MyBlankProject - hyla create --t asciidoc -a video -d ~/hyla/MyBlankProject - hyla create --t asciidoc -a source -d ~/hyla/MyBlankProject - hyla create --t asciidoc -a table -d ~/hyla/MyBlankProject + hyla add --t asciidoc -a article -d ~/hyla/MyBlankProject + hyla add --t asciidoc -a book -d ~/hyla/MyBlankProject + hyla add --t asciidoc -a image -d ~/hyla/MyBlankProject + hyla add --t asciidoc -a audio -d ~/hyla/MyBlankProject + hyla add --t asciidoc -a video -d ~/hyla/MyBlankProject + hyla add --t asciidoc -a source -d ~/hyla/MyBlankProject + hyla add --t asciidoc -a table -d ~/hyla/MyBlankProject == 3. Create a Blank Project using _config.yaml config file, add artefacts - Clean up project and create a MyBlankProject (= directory) using --force option @@ -156,17 +160,17 @@ cd MyBlankProject - Create Asciidoc files from samples (book, article, image, audio, ...) - hyla create --a article - hyla create --a book - hyla create --a image - hyla create --a audio - hyla create --a video - hyla create --a source - hyla create --a table + hyla add --a article + hyla add --a book + hyla add --a image + hyla add --a audio + hyla add --a video + hyla add --a source + hyla add --a table === 4. Generate HTML Content of an existing project (asciidoc 2 html) hyla generate -r adoc2html -s ~/hyla/MyBlankProject/ -d ~/hyla/MyBlankProject/generated_content @@ -182,11 +186,11 @@ hyla generate -r adoc2html -s . -d generated_content === 7. Generate HTML Content within project & using Config File - As destination directory is not longer '.' (which is the case when we add artefacts using `hyla create` command, then we must change the destination directory to `generated_content`. the original file is + As destination directory is not longer '.' (which is the case when we add artefacts using `hyla add` command, then we must change the destination directory to `generated_content`. the original file is still available as it will backup by ruby ruby -i.bak -pe 'sub(%r{destination: .},"destination: generated_content")' _config.yaml hyla generate hyla generate -y foundation @@ -287,16 +291,16 @@ hyla watch -s ~/hyla/MyTocProject/ -d generated_content === 3. Generate a DeckJS Slideshow for a module cd ~/hyla/MyTocProject - hyla generate --backend deckjs -s A_Introduction_module/ -d A_Introduction_module/generated_content -r index2htmlslide + hyla generate --backend deckjs -s A_Introduction_module/ -d A_Introduction_module/generated_content -r index2html === 4. Generate a DeckJS Slideshow for a Project (all the TOC) cd ~/hyla/MyTocProject - hyla generate --backend deckjs -s . -d generated_content -r index2htmlslide + hyla generate --backend deckjs -s . -d generated_content -r index2html == 5. Server content locally - HTTP Server To simplify your life, a simple HTTP Server can be started by Hyla and will allow to consult/browse HTML files generated. In this case, start this Hyla command in another Terminal @@ -309,29 +313,29 @@ rm -rf ~/hyla/MyDeckSlideShow cd ~/hyla hyla new -b -d MyDeckSlideShow - hyla create --t slideshow -a deckjs -d MyDeckSlideShow - hyla generate --backend deckjs -s ~/hyla/MyDeckSlideShow -d ~/hyla/MyDeckSlideShow/generated_content -r adoc2htmlslide + hyla add --t slideshow -a deckjs -d MyDeckSlideShow + hyla generate --backend deckjs -s ~/hyla/MyDeckSlideShow -d ~/hyla/MyDeckSlideShow/generated_content -r adoc2html === 2. Different DeckJS Style options - hyla generate --backend deckjs -s ~/hyla/MyDeckSlideShow -d ~/hyla/MyDeckSlideShow/generated_content -r adoc2htmlslide -a deckjs_theme=swiss,deckjs_transition=fade - hyla generate --backend deckjs -s ~/hyla/MyDeckSlideShow -d ~/hyla/MyDeckSlideShow/generated_content -r adoc2htmlslide -a deckjs_theme=web-2.0,deckjs_transition=horizontal-slide + hyla generate --backend deckjs -s ~/hyla/MyDeckSlideShow -d ~/hyla/MyDeckSlideShow/generated_content -r adoc2html -a deckjs_theme=swiss,deckjs_transition=fade + hyla generate --backend deckjs -s ~/hyla/MyDeckSlideShow -d ~/hyla/MyDeckSlideShow/generated_content -r adoc2html -a deckjs_theme=web-2.0,deckjs_transition=horizontal-slide === 3. RevealJS rm -rf ~/hyla/MyRevealSlideShow cd ~/hyla hyla new --blank -d MyRevealSlideShow - hyla create --t slideshow -a revealjs -d MyRevealSlideShow + hyla add --t slideshow -a revealjs -d MyRevealSlideShow cd MyRevealSlideShow - hyla generate --backend revealjs -s . -d generated_content -r adoc2htmlslide + hyla generate --backend revealjs -s . -d generated_content -r adoc2html open http://localhost:4000/hyla/slideshow_revealjs.html & hyla serve -P 4000 -H localhost -b /hyla/ -d generated_content/ @@ -347,11 +351,11 @@ hyla new -b -d MyPdfProject --force cd MyPdfProject - Create Asciidoc file from sample (book) - hyla create -a book --t asciidoc -d . + hyla add -a book --t asciidoc -d . - Generate HTML content using foundation stylesheet hyla generate --style foundation @@ -391,11 +395,11 @@ user: 'your_gmail_user' password: 'your_gmail_password!' Two new options are required to process the request on the command line or using _config.yaml file - location: ./generated_content + source: ./generated_content file: name_of_html_file - Create a Blank project cd ~/hyla @@ -403,10 +407,10 @@ hyla new -b -d MyEmailProject --force cd MyEmailProject - Add an asciidoc file (report, doc, book, article) - hyla create --a book --d . + hyla add --a book --d . - Edit the _config.yaml file and add the parameters required (see previously) - Generate HTML content using foundation stylesheet