The lektor static file content management system
Python JavaScript CSS HTML Shell Makefile
Clone or download
nixjdm Merge pull request #565 from lektor/lektor-522
[lektor-522] Adding long description.
Latest commit ea8367f Jul 3, 2018

README.md

Lektor

Unix Build Status Windows Build Status Code Coverage PyPI version Join the chat at https://gitter.im/lektor/lektor

Lektor is a static website generator. It builds out an entire project from static files into many individual HTML pages and has a built-in admin UI and minimal desktop app.

To see how it works look at the example folder which contains a very basic project to get started.

For a more complete website look at lektor/lektor-website which contains the sourcecode for the official lektor website.

How do I use this?

For installation instructions head to the official documentation:

Want to develop on Lektor?

This gets you started:

$ git clone https://github.com/lektor/lektor
$ cd lektor
$ virtualenv venv
$ . venv/bin/activate
$ pip install --editable .
$ make build-js
$ make install-git-hooks
$ export LEKTOR_DEV=1
$ lektor quickstart --path example-project
$ lektor --project example-project server

If you want to run the test suite instead:

$ virtualenv venv
$ . venv/bin/activate
$ pip install --editable ".[test]"
$ make test