Decidim Documentation

This is the new repository for the Decidim Documentation website. Is built with Antora.

Install locally

Manually

Install antora with software dependencies.

# Install Node & npm using nvm
wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.3/install.sh | bash
nvm install node

# Install Antora and dependencies
npm install

If antora installation succeed, antora -v will return antora's version.

Clone repository and build documentation website.

git clone https://github.com/decidim/documentation
cd documentation
./bin/build

The generated website will be create under build/site/ folder. Open index.html with any browser.

xdg-open build/site/index.html

Docker

You can check this locally and install with Docker.

git clone https://github.com/decidim/documentation
cd documentation
docker run -u $(id -u) -e DOCSEARCH_ENABLED=true -e DOCSEARCH_ENGINE=lunr -v $PWD:/antora:Z --rm -t antora/antora --generator antora-site-generator-lunr antora-playbook.yml
xdg-open build/site/index.html