Skip to content

toucansites/toucan

Repository files navigation

Toucan

Toucan is a markdown-based Static Site Generator (SSG) written in Swift.

Prerequisite

Ensure you have Swift installed. For instructions check how to install swift

Install

Clone or download the repository & run:

# clone the repository & install toucan
git clone https://github.com/toucansites/toucan.git
cd toucan
make install
# alternatively, if you encounter permission errors:
# sudo !!
# verify installation
which toucan

Quickstart

To quickly bootstrap a Toucan-based static site, run the following commands:

toucan init my-site
cd my-site
toucan generate
toucan serve
# Visit: http://localhost:3000

Documentation

The complete documentation for Toucan is available on toucansites.com.