Skip to content

Documentation site for Decidim project built with Antora

Notifications You must be signed in to change notification settings

decidim/documentation

Folders and files

NameName
Last commit message
Last commit date

Latest commit

deb39c9 · Sep 27, 2023
May 23, 2022
Jul 20, 2023
Sep 27, 2023
May 23, 2022
Sep 3, 2021
Oct 13, 2021
Oct 13, 2021
Aug 4, 2020
Mar 14, 2022
Jul 20, 2023
Jul 21, 2023
May 23, 2022
May 23, 2022
Jul 20, 2023

Repository files navigation

Decidim Documentation

Netlify Status

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