This is the repository for the Decidim Documentation website. Is built with Antora.
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
# Validate the AsciiDoc content (xrefs, includes, images, syntax) without
# generating the website
npm run lint
# Build the static site
npm run build
# Serve the generated website. The content manager (Sveltia CMS) runs at
# http://localhost:8080/admin/index.html; use "Work with Local Repository" in a
# Chromium-based browser to save changes straight to your local git worktree.
npm run dev:admin
# For ease of contributor experience, we recommend using the Sveltia UI
xdg-open http://localhost:8080
xdg-open http://localhost:8080/adminYou can work locally using the development container.
git clone https://github.com/decidim/documentation
cd documentation
bin/devcontainer up
bin/devcontainer npm run build
bin/devcontainer npm run dev:admin
xdg-open build/site/index.html