Skip to content

SuCoS-SSG/SuCoS

Repository files navigation

SuCoS

SuCoS logo

🎉 Welcome to SuCoS (JuiCeS, in Brazilian Portuguese), is a fast and powerful Static Site Generator! 🚀

Official site: https://sucos.brunomassa.com

Latest release Pipeline Latest release Codacy Badge

Install

All the Releases for Linux, Windows are a single executable! Just download and use.

Usage

First, navigate to the SuCoS folder, then, run the following command:

SuCoS <YOUR_SITE_PATH>
SuCoS.exe <YOUR_SITE_PATH>

if <YOUR_SITE_PATH> not present, it will default to current folder.

Watch in awe as SuCoS creates a static site from your input files, or as it possibly implodes (with a 50/50 chance).

If all goes well (fingers crossed 🤞), you'll have a shiny new static website in the public folder.

Build Requirements

SuCoS is built with DotNet 8, and the latest C# speed and features!

git clone https://gitlab.com/sucos/sucos.git # or [email protected]:sucos/sucos.git
cd SuCoS
build.sh clean restore compile # or dotnet build

License

This piece of software is brought to you under the MIT license, because we believe in the power of sharing (and bug fixing together).

Contributing

We welcome contributions in the form of bug reports, feature requests, and pull requests. Just remember, we're here for the fun, so keep it light-hearted and enjoyable! Check our guidelines.

Final Words

Remember, SuCoS is a work in progress, and it's important to maintain calm while using this software. Have fun, and may the 4th be with you! 😄

Created by Bruno MASSA and hopefully your contributions too!