Table of Contents #

• Quick Start
  • Installation
    • Brew taps for macOS
    • Installing anna from releases
    • Installing anna with go
  • Usage
    • Running anna
    • Serving the site with live reload to watch for file updates
    • Other commands and flags

Quick Start #

Installation #

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
Copy

Installing anna from releases #

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
Copy

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@v3.0.0 -s './'
Copy

Usage #

Running anna #

anna
Copy

• Render the site located at site_path

anna -p [site_path]
Copy

Serving the site with live reload to watch for file updates #

anna -s
Copy

• Serve the site located in site_path

anna -s -p [site_path]
Copy

Other commands and flags #

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

  anna -h
Copy