An open API service indexing awesome lists of open source software.

https://github.com/lektor/lektor

The lektor static file content management system
https://github.com/lektor/lektor

cms static-site-generator

Last synced: 28 days ago
JSON representation

The lektor static file content management system

Awesome Lists containing this project

README

          

# Lektor

[![CI/CD Badge]][CI/CD]
[![PyPI version](https://badge.fury.io/py/Lektor.svg)](https://pypi.org/project/Lektor/)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/Lektor.svg)](https://pypi.org/project/Lektor/)
[![Code Style: Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Join the chat at https://gitter.im/lektor/lektor](https://badges.gitter.im/lektor/lektor.svg)](https://gitter.im/lektor/lektor?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

[CI/CD Badge]: https://github.com/lektor/lektor/actions/workflows/ci-cd.yml/badge.svg?branch=master
[CI/CD]: https://github.com/lektor/lektor/actions/workflows/ci-cd.yml

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 top-level `example/` folder, which contains
a showcase of the wide variety of Lektor's features.

For a more complete example look at the [lektor/lektor-website](https://github.com/lektor/lektor-website)
repository, which contains the source code for the official Lektor website.

## How do I use this?

For installation instructions head to the official documentation:

- [Installation](https://www.getlektor.com/docs/installation/)
- [Quickstart](https://www.getlektor.com/docs/quickstart/)

## Want to develop on Lektor?

This gets you started (assuming you have [Python] >= 3.10, [npm], and
[uv] installed):

[python]: https://www.python.org/
[uv]: https://docs.astral.sh/uv/
[npm]: https://nodejs.org/

```bash
$ git clone https://github.com/lektor/lektor
$ cd lektor
$ python -m venv _venv
$ . _venv/bin/activate

# pip>=25.1 is required for PEP 735 support
$ pip install -U "pip>=25.1"

# NB: this step requires that npm is installed (see below)
$ pip install --group dev --editable .

# If you plan on committing:
$ uv run prek install

# Run the Lektor server
$ export LEKTOR_DEV=1
$ cp -r example example-project
$ lektor --project example-project server
```

If you want to run the whole test suite, under various versions of
python, etc. (you'll need [tox] installed):

[tox]: https://tox.wiki/

```sh
$ tox
```

Or run the tests directly in your dev environment

```sh
$ pytest [...]
```

> [!NOTE]
> The admin front-end resources (e.g. `.js` and `.css` files) in `lektor/admin/static`
> get built as part of the python distribution build process.
> This happens, e.g., when running `pip install -e .`
>
> That magic may be disabled (you might want to do this if, e.g., `npm` is not
> available in your dev environment) by setting the `HATCH_BUILD_NO_HOOKS`
> environment variable during the build. E.g.
>
> ```sh
> HATCH_BUILD_NO_HOOKS=true pip install --group dev --editable .
> ```