austinvernsonger / taiga-doc

Taiga documentation source.

Taiga documentation source

Status: Still a work in progress

Web: http://taigaio.github.io/taiga-doc/dist/

Setup initial environment (for developers)

Install requirements: Ruby / asciidoctor + pygments.rb (installed via. bundler using the provided Gemfile)

You can install Ruby through the apt package manager, pacman, rbenv, or rvm.

Confirm that Gemfile is in the base taiga-doc directory and then perform the installation from that directory:

$ cd taiga-doc
$ export PATH=$(ruby -e "print Gem.user_dir")"/bin:$PATH"
$ export GEM_HOME=$(ruby -e 'print Gem.user_dir')
$ gem install bundler
$ bundle
$ asciidoctor -v // should return Asciidoctor 1.5.1 ...

(Optional) Setup live preview in browser

Prerequisite: Initial environment above must be setup and working

Overview

This step is optional but highly recommended in order to ease the process of editing AsciiDoc files, by rendering the HTML from the source .adoc file as soon as any modifications are saved - allowing for instant preview in the browser.

The following instructions are based on:

• The Asciidoctor page: Editing AsciiDoc with Live Preview
• The Guard README: Guard: README.md

Installation

If the bundler install completed successfully, all of the gems will already be in place (including both Guard and the shell file monitor).

For notifications to work properly:

You have to install the libnotify-bin package with your favorite package manager

-- Guard: System notifications - Libnotify

For example, on a Debian-based system:

$ sudo apt-get install libnotify-bin

Or in Arch

$ yaourt -S libnotify

Ensure Guard is working

It's important that you always run Guard through Bundler to avoid errors.

-- Guard: README.md

Confirm that Guardfile is in the base taiga-doc directory and then start Guard from that directory:

$ cd taiga-doc
$ bundle exec guard

• Open index.adoc in a text editor, make a minor modification and then save the file
• If Guard is working properly, dist/index.html will be created/updated automatically
• If libnotify is configured correctly, a notification will be shown confirming that index.adoc has been found and rendered accordingly

Configure live preview in the browser

Note: The Asciidoctor page suggests using LiveReload with the guard-livereload gem but this package is no longer compatible with LiveReload 2

Simply use a browser that has auto-reload built-in or install a relevant browser add-on.

Examples include:

• Web web browser (formerly Epiphany web browser) - has built-in auto-reload functionality
• Firefox + Auto Reload add-on
• [Please add other working configurations here]

Test live preview

• Open dist/index.html in the browser
• As before, save a modification to index.adoc
• Once Guard has rendered the new copy of dist/index.html, the browser will auto-reload the page

Working with live preview

Some tips/notes about working with live preview:

• Position the text editor and web browser windows side-by-side (or on different screens!), save changes and see the result in the browser almost immediately
• Changes to any of the .adoc files within the api/ directory or its sub-dirs will render dist/api.html - since many .adoc files are combined to render the single HTML file, there is a slight lag in the live preview as the conversion process completes
• Otherwise, there is a 1:1 relationship between the .adoc file and its rendered .html file - changes to these are displayed almost instantaneously