Skip to content

README.md

Latest commit

 

History

History
31 lines (26 loc) · 1.39 KB

README.md

File metadata and controls

31 lines (26 loc) · 1.39 KB

VIVIDUS documentation

This is a playbook repo. It's purpose is keeping 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 Site Generator With Lunr
npm i -g @antora/cli antora-site-generator-lunr
  1. Generate a site
DOCSEARCH_ENABLED=true DOCSEARCH_ENGINE=lunr DOCSEARCH_INDEX_VERSION=latest NODE_PATH="$(npm -g root)" antora --generator antora-site-generator-lunr 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 antora-site-generator-lunr && \  
 git clone https://github.com/vividus-framework/vividus.git && \   
 git clone https://github.com/vividus-framework/docs.vividus.dev.git && \   
 cd docs.vividus.dev && \
 DOCSEARCH_ENABLED=true DOCSEARCH_ENGINE=lunr DOCSEARCH_INDEX_VERSION=latest NODE_PATH="$(npm -g root)" antora --generator antora-site-generator-lunr antora-playbook-local.yml && \  
 open ./public/index.html