Skip to content

thefrontside/staticalize

Repository files navigation

Staticalize

The framework agnostic static site generator.

Every language has its own static site generator, and every static site generator is made obsolete by the next static site generator that comes along to replace it every few years. Staticalize lets you hop off that hamster wheel.

It does this by providing a general mechanism to convert any dynamically generated website into a static one. It doesn't care what framework you use to generate your content so long as it is served over HTTP and has a sitemap. It will analyze your sitemap and generate a static website for it in the output directory of your choice. All you need to provide is url of the server you want to staticalize and the base url of your production server.

For example, if you have the sourcecode of the frontside.com website running on port 8000, you can build a static version of the website fit to serve on frontside.com into the dist/ directory with the following command:

$ staticalize --site https://localhost:8000 --base http://frontside.com --output dist

This will read https://localhost:800/sitemap.xml and download the entire website to the dist/ directory in a format that can be served from a simple file server running at frontside.com.

CLI

Usage: staticalize [OPTIONS] <site>

Arguments:
   <site>                    URL of the website to staticalize. E.g. http://localhost:8000

Options:
   --output <OUTPUT>         Directory to place the downloaded site [default: dist]
   --base <BASE>             Base URL of the public website. E.g. http://frontside.com
   --strict                  Fail on the first download error instead of collecting all failures and continuing [default: false]
   -h, --help                show help
   -v, --version             show version

By default, staticalize downloads as much of the site as it can: any page or asset that fails is reported at the end and the process exits non-zero, but the run continues so you get every page that did work. Pass --strict to fail fast and abort the whole run on the first download error.

About

The framework agnostic static site generator

Resources

Code of conduct

Stars

7 stars

Watchers

1 watching

Forks

Packages

 
 
 

Contributors