ecoCode developer documentation

This repository contains the Antora playbook to ecoCode’s developer documentation.

Table of Contents

• Contributing
  • Building the project
  • Deploying to GitHub Pages

Contributing

Building the project

1. Clone the repository and cd to directory:

   git clone https://github.com/cychop/ecoCode-docs.git
   cd ecoCode-docs

2. Install the required dependencies:

   npm install

3. Build the documentation site:

   npm run build

   The result is available under dist/site.

💡	When contributing, you can run npm run preview in another terminal to start a local web server and check the website in your browser.

Deploying to GitHub Pages

A GitHub Action has been defined to enable deploying the documentation website to GitHub Pages.

• Prerequisite: In the Pages settings of the project, under Build and deployment, select GitHub Actions under Source.

• On the Publish to GitHub Pages page, click Run workflow to build and deploy the website. After building, it will be available at https://cychop.github.io/ecoCode-docs/.