VIVIDUS documentation

This is a playbook repo. It's purpose is to keep the way we deploy VIVIDUS documentation and UI customizations. We use

• Antora as a static site generator
• Asciidoctor as a documentation format and text processor
• Lunr as an offline search engine.

Local environment

1. Install Node.js
2. Install Antora and Antora Lunr Extension

   npm i -g @antora/cli@3.1.7 @antora/site-generator@3.1.7 @antora/lunr-extension@1.0.0-alpha.8

3. Generate a site

   antora antora-playbook-local.yml

IMPORTANT: the cloned docs.vividus.dev repository should be placed by default in the same folder as vividus repository (this behavior could be changed in the playbook).

One liner

 npm i -g @antora/cli@3.1.7 @antora/site-generator@3.1.7 @antora/lunr-extension@1.0.0-alpha.8 && \
 git clone https://github.com/vividus-framework/vividus.git && \   
 git clone https://github.com/vividus-framework/docs.vividus.dev.git && \   
 cd docs.vividus.dev && \
 antora antora-playbook-local.yml && \  
 open ./public/index.html

PDF Generation

1. Install Asciidoctor PDF

   gem install asciidoctor-pdf

2. Install the Antora PDF Extension

   npm i -g @antora/pdf-extension

3. Generate a PDF document

   antora --extension @antora/pdf-extension antora-playbook-local.yml