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 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 Installing Mandy is simple! Run one of the commands below for your platform to download a script that will install Mandy.
- Run this command in a Powershell session with administrator privileges if you are running on a Windows 32-bit system:
. { iwr -useb https://angeldollface.art/mandys-house/installers/win_32.ps1 } | iex; ./win_32.ps1
- Run this command in a Powershell session with administrator privileges if you are running on a Windows 64-bit system:
. { iwr -useb https://angeldollface.art/mandys-house/installers/win_64.ps1 } | iex; ./win_64.ps1
For non-Windows platforms, run this command. You may have to put sudo
in front of this command:
curl -s https://angeldollface.art/mandys-house/installers/nix.sh | bash -s
π¨
MANDY TEMPLATE SITES - Mandy's Default Site Template: The default template site for creating new Mandy-powered sites. Start a new Mandy site with this site template like this:
mandy -i mysite -w angeldollface/mandy-template-site
. - Mandy's main website: The Mandy site for the project page of the Mandy project. Start a new Mandy site with this site template like this:
mandy -i mysite -w angeldollface/mandys-house
. - Mandy's fancy template site with in-browser 3D graphics: A single-page site template using three.js for the Mandy static-site generator. Start a new Mandy site with this site template like this:
mandy -i mysite -w angeldollface/mandy-threejs-site
.
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.
HELP AND COMMUNITY π«
NOTE π
- Mandy
π π π₯ by Alexander Abrahamπ€ a.k.a. "Angel Dollface"π π - Licensed under the MIT license.