aboutsummaryrefslogtreecommitdiff

SWG

Static Website Generator.

Requirements

You will need to have cmake installed along with a C++ compiler that supports the C++17 library (Filesystem library is used).

Compile

Navigate to the project root and create the build folder along with the Makefiles:

mkdir build
cd build
cmake ..

You should now be able to compile the project by simply running make.

The resulting executable will be located at build/src/swg. As it is a standalone executable, you could install it by simply copying it in the /bin folder:

sudo cp src/swg /bin/swg

Usage

swg -g source-website

The generation of a static website is done from a folder and file structure, you can see a template here.

Status

It is still under development, really far from being finished. You can take a look at TODO to have an idea of what is planned / under development.

License

Using the maddy C++ Markdown to HTML header-only parser library developed by Petra Baranski.

This project is licensed under the GPLv3 license. For more information see LICENSE file.