Skip to main content

a tiny static website generator

Project description

legoman

Simple static website generator.

Supports TOC, image captions, LaTeX, code highlighting and tables.

Demo

Usage

pip install legoman

# in an empty directory
legoman init
make html

# run devserver (requires inotify-tools)
make devserver

How it works

Files in content/ are rendered and copied to output/, so the directory structure of your rendered website matches the structure of your source files.

For example, the demo content/:

content
├── codehilite.css
├── index.j2
├── projects
│   ├── bar_proj
│   │   └── index.md
│   └── foo_proj
│       ├── cheetos_small.png
│       └── index.md
└── styles.css

yields this output/

output
├── codehilite.css
├── index.html
├── projects
│   ├── bar_proj
│   │   └── index.html
│   └── foo_proj
│       ├── cheetos_small.png
│       └── index.html
└── styles.css

CGI

Legoman can also render files on the fly, which is useful for dynamically rendering files on a webserver.

echo '# hello world' | legoman cgi md

Or for serving markdown with lighttpd:

$HTTP["url"] =~ "\.md$" {
    cgi.assign = ( ".md"  => "/path/to/legoman cgi md")
}

Usage

Usage: legoman [OPTIONS] COMMAND [ARGS]...

Options:
  --debug
  --content_dir PATH
  --output_dir PATH
  --template_dir PATH
  --help               Show this message and exit.

Commands:
  build  generate content
  cgi    run as CGI
  init   initialize project

See also

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

legoman-3.0.0.tar.gz (32.1 kB view hashes)

Uploaded Source

Built Distribution

legoman-3.0.0-py3-none-any.whl (31.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page