-
Installed Asciidoctor using RVM, after installing-uninstalling it using brew and learned that I was in a dead end when I wanted to install additional required gems.
curl -#L https://get.rvm.io | bash -s stable --autolibs=3 --ruby gem install asciidoctor tilt thread_safe haml
-
Installed the Asciidoctor.js Live Preview Chrome extension
-
Created this repo. Went for a
src
folder for the content and adocs
folder for github pages. Thedocs
folder appriach look much more easy to manage than the traditionalgh-pages
branch. -
Created an
index.html
file in thedocs
folder, including a typo, committed, pushed, changed the setting to enable github pages and https://xverges.github.io/ml-social-science/ was available! -
bespoke.js looks nice, but seems to carry too much weight around it. It is minimalist, but it needs a quite specific tool-chain.
-
Decided to use the deck.js backend because it seems to support TOC, an important feature for me. Install looked simpler to install than the reveal.js backend (at least, for a Ruby illiterate like me)
git submodule add https://github.com/asciidoctor/asciidoctor-deck.js pushd docs && git submodule add https://github.com/imakewebthings/deck.js && popd asciidoctor -T asciidoctor-deck.js/templates/haml/ --destination-dir docs --out-file index.html src/intro.adoc
-
Well, no TOC after all.
-
Stop that! The
:menu:
attribute adds an overview mode triggered withm
. -
github happy with the use of submodules!