Kwpolska / miniwww

A small generator for even smaller webpages.

Mini WWW Generator

A small generator for even smaller webpages.

How to use it?

Put your assets in the assets/ directory, source files in input/ and expect output in output/. Look at inputsample.html for examples.

This generator was built to play with Python 3.6’s new syntax features (f-strings and variable type annotations) as well as Python typechecking in general (passes mypy --strict). As such, it requires Python 3.6 or later.

Does it do X? Is it any good?

Probably not and probably not. If you’re looking for a real, feature-packed static site generator, look at Nikola. (I’m the top 2 contributor to Nikola by commit count.)

What do you use it for?

Public resources: http://kwpolska.github.io/, https://chriswarrick.com/404, https://chriswarrick.com/gen/factoids.html

And some private ones as well. (I’m using different templates/CSS/assets to what is publicly available in this repo.)

License

Copyright © 2017-2023, Chris Warrick. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions, and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions, and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. Neither the name of the author of this software nor the names of contributors to this software may be used to endorse or promote products derived from this software without specific prior written consent.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.