lightweight 1.0.0.dev21

Static site generator i actually can use.

lightweight

Static site generator i actually can use.

Documentation

Features

• Clean and easily extensible API
• Jinja2 templates
• Markdown rendering
• Sass/SCSS rendering
• RSS/Atom feeds
• Dev server
• CLI

Installation

Available from PyPI:

pip install lightweight

Quick Example

from lightweight import Site, markdown, paths, render, template, rss, atom, sass


def blog_posts():
    post_template = template('blog-post.html')
    # Use globs to select files.
    return (markdown(path, post_template) for path in paths('posts/**.md'))


site = Site(url='https://example.org')

# Render an index page from Jinja2 template.
site.include('index.html', render('pages/index.html'))

# Render markdown blog posts.
[site.include(f'posts/{post.filename.stem}.html', post) for post in blog_posts()]
site.include('posts.html', render('pages/posts.html'))

# Syndicate RSS and Atom feeds.
site.include(f'posts.atom.xml', atom(site['posts']))
site.include(f'posts.rss.xml', rss(site['posts']))

# Render SASS to CSS.
site.include('css/style.css', sass('styles/style.scss'))

# Include a copy of a directory.
site.include('img')
site.include('js')

# Execute all included content. 
site.render()

Dev Server

Lightweight includes a simple static web server with live reload serving at 0.0.0.0:8080 (can be accessed via localhost:8080):

python -m lightweight.server <directory>

The live reload can be disabled with --no-live-reload flag:

python -m lightweight.server <directory> --no-live-reload

Otherwise every served html file will be injected with a javascript that polls /id. The script reloads the page when the /id changes. The /id changes every time on any file change at the served directory.

Host and port can be set via:

python -m lightweight.server <directory> --host 0.0.0.0 --port 8080

To stop the server press Ctrl+C in terminal.