/SauSaGe

a static site generator

Primary LanguageC++MIT LicenseMIT

SauSaGe

A Static Site Generator. Reads text files and converts them into .html files. Recently also updated to read .md files and parse certain markdown tokens.

Usage

Download SauSaGe.exe from the releases and execute in command line interface using options.

Must be executed from the directory where SauSaGe.exe is located.

Options

  • -v or --version - display the application name and version
  • -h or --help - display application options
  • -i or --input - set the input file/directory
  • -o or --output - set the output directory (./dist by default)
  • -t or --test - run unit tests

Usage Examples

  • SauSaGe -i textFile.txt
  • SauSaGe -i markDown.md
  • SauSaGe -i inputDir
  • SauSaGe -i inputDir -o outputDir

Optional Requirements Implemented

  • Parses title from input files, changes HTML page title and header accordingly.
  • -o and --output options allow specification of output directory.
  • Recursively searches directory structure for text files and converts all of them into .html files.
  • Creates an index.html file that links to the output files created if a directory is specified as input
  • Also is able to read .md files, where it successfully uses Heading 1 and 2 (# and ##) features of Markdown
  • Bold and Italics wrapped in single or double asterisks or underscores can be read from .md files. eg: **Bold** or _italic_