Table of Contents #

Quick Start #

Installation #

Installing anna from releases #

Run this in the appropriate folder.

If a site directory with the pre-requisite layout template has not been defined, anna proceeds to fetch the default site directory from the anna github repository

curl -L https://github.com/anna-ssg/anna/releases/download/version-tag/releases-name.tar.gz > anna.tar.gz
tar -xvf anna.tar.gz # unzip the tar file
rm anna.tar.gz # removing the tar file

# here you could add anna to your path if you want and use in in any directory
./anna # runs anna. The instructions are given below

Brew taps for macOS #

To install anna on macOS via brew, run the below commands:

brew tap anna-ssg/anna
brew install anna

# to run anna
anna

Installing anna with go #

If you have the Go toolchain installed, run the below command to download and build anna:

go run github.com/anna-ssg/anna@v3.0.0

Usage #

Running anna #

  1. To run anna, create an anna.yml file to configure how sites are rendered and served

Sample anna.yml #

siteDataPaths:
  - site: site/
  - site-test: site-test/
  1. Run the render command
anna

anna -r [site_path]

Serving the site with live-reload #

  1. To serve the site, create an anna.yml file to configure how sites are rendered and served

Sample anna.yml #

siteDataPaths:
  - site: site/
  - site-test: site-test/
  1. Run the serve command
anna -s [site_path]

Note: Running anna -s without specifying the site_path will throw an error

Other commands and flags #

To view allthe commands and flags available, run the below command:

  anna -h