Skip to content

Cutwell/static-site-generator

Repository files navigation

Static Site Generator

A CLI tool for converting Markdown to HTML.

License: MIT PyPI

Demo of the Read Me template command line app. It shows the user running.

Install

pip install static-site-gen

Usage

ssg [-h] [--help] [--safe] [--debug] [--run=<project_root>] [--config=<config.toml>] [--ignore=<.ssgignore>]
Flag Description
-h, --help Show this help message and exit (optional).
--safe Don't overwrite existing files (optional).
--run= Specify website root folder (required).
--config= Default metadata configuration in YAML format (optional).
--ignore= Filepath to list of newline separated file paths to skip (optional).
--debug Enable debug logging (optional)

Docs

For further customisation and run instructions, see here.

Contributing

For information on how to set up your dev environment and contribute, see here.

License

MIT