AgDS Image Generator

This repo generates images for the Agriculture Design System (AgDS) documentation website.

System dependencies

To run the scripts in this repository you will need version 18.18.2 of Node.js installed and the yarn (v1) package manager.

We recommend using nvm to manage node versions: https://github.com/nvm-sh/nvm

Getting started

1. This repo requires AgDS’ Example Site. Ensure that it’s setup correctly by following its instructions.
2. Clone this repo to your local machine, in a sibling directory to the agds-next repo.
3. cd into the repo and run yarn to install and link dependencies.

Running the scripts

1. Run the example site in the agds-next repo: yarn example:dev
2. Run yarn generate-docs-guide-images to generate guide images
3. Run yarn generate-docs-template-images to generate template images

These scripts will create and alter images in the main agds-next directory. They will need to be added and committed in that repo.