angeldollface / mandy

A hypersonic static-site generator written in Rust. :rocket: :pill: :fire:

MANDY 🚀 💊 🔥

A hypersonic static-site generator written in Rust. 🚀 💊 🔥

ABOUT 📚

Mandy is fast, easy to use, easy to deploy, and very flexible! Get her today! Visit Mandy's website!

GETTING STARTED 📚

Showcase

Get a binary!

You can download a compiled binary for 64-bit desktop systems from this repository's Releases section.

Alternatively, if you have the Rust toolchain installed, you can install Mandy via Cargo using this command:

cargo install --git https://github.com/angeldollface/mandy.git mandy-bin --tag v.0.3.4

Get up and running!

# Check that Mandy is installed.
mandy -v

# Set the $MANDY_ENV environment variable. (For *Nix systems.)
export MANDY_ENV="development"

# Set the $MANDY_ENV environment variable. (For Windows systems.)
set MANDY_ENV="development"

# Start a new Mandy-powered site in "mysite".
mandy -i mysite -w angeldollface/mandy-template-site

# Compile your Mandy site.
mandy -c mysite

# Clean your Mandy project.
mandy -r mysite

# Test your site on "localhost".
mandy -s mysite

INSTALLATION 📥

To view all installation options for Mandy please view the project's official installation page.

MANDY TEMPLATE SITES 🎨

You can find all available template sites for starting a new Mandy-powered site here.

DEPLOYING A MANDY-POWERED SITE ON GITHUB PAGES 🚀

Mandy has her own GitHub Action to deploy your Mandy-powered site on GitHub Pages. You can find out more about that here. Other deployment services are also supported.

CHANGELOG ✒️

There is a detailed log of current features and past ones here.

HELP AND COMMUNITY 🫂

• Mandy's Website
• Mandy's Documentation
• Mandy's Discord Server

NOTE 📜

• Mandy 🚀 💊 🔥 by Alexander Abraham 🖤 a.k.a. "Angel Dollface" 🎎 🎀
• Licensed under the MIT license.