README.md

Decidim Documentation

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

Install locally

Manually

Install antora with software dependencies.

# Install Node and Npm, for instance using nvm:
wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.3/install.sh | bash
nvm install node

# 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

# Install Antora and dependencies
npm install

# build the static site
npm run 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
./bin/dbuild
xdg-open build/site/index.html