Metadata-Version: 2.1
Name: legoman
Version: 3.0.2
Summary: a tiny static website generator
Home-page: https://github.com/evidlo/legoman
Author: Evan Widloski
Author-email: evan@evanw.org
License: GPLv3
Keywords: static web generator jinja2 markdown
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/markdown
Requires-Dist: click
Requires-Dist: colorama
Requires-Dist: ghp-import
Requires-Dist: httpwatcher
Requires-Dist: jinja2
Requires-Dist: markdown
Requires-Dist: markdown-captions
Requires-Dist: mdx-include
Requires-Dist: python-markdown-math

# legoman

<img src="demo/content/man.svg" width=200>

Simple static website generator.

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

[Demo](http://evanw.org)

# Usage

``` bash
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
- [Hugo](https://github.com/gohugoio/hugo) - similar idea, but written in Go and uses Go's templating engine
- [Dozens of other static website generators](https://www.staticgen.com/)


