https://github.com/lektor/lektor

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

cms static-site-generator

Last synced: 5 days ago
JSON representation

The lektor static file content management system

• Host: GitHub
• URL: https://github.com/lektor/lektor
• Owner: lektor
• License: bsd-3-clause
• Created: 2015-12-19T09:18:36.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2024-09-19T19:57:23.000Z (about 2 months ago)
• Last Synced: 2024-10-02T01:21:04.413Z (about 1 month ago)
• Topics: cms, static-site-generator
• Language: Python
• Homepage: https://www.getlektor.com/
• Size: 8.85 MB
• Stars: 3,816
• Watchers: 76
• Forks: 306
• Open Issues: 246
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-python-applications - Repo - in admin console and minimal desktop application. `(linux, windows, mac)` (<a id="tag-static_site" href="#tag-static_site">Static Site</a>)
• awesome-foss-alternatives - Lektor - The lektor static file content management system. [🐍, BSD 3-Clause "New" or "Revised" License]. (Web / Static website generator)
• awesome-python-applications - Repo - in admin console and minimal desktop application. `(linux, windows, mac)` (<a id="tag-static_site" href="#tag-static_site">Static Site</a>)
• awesome-static - **Lektor**
• starred-awesome - lektor - The lektor static file content management system (Python)
• awesome-starred - lektor/lektor - The lektor static file content management system (others)
• best-of-web-python - GitHub - 36% open · ⏱️ 15.05.2024): (Content Management Systems)
• awesome-homelab - Lektor

README

        
# Lektor

[![Tests master](https://github.com/lektor/lektor/workflows/Tests%20master/badge.svg)](https://github.com/lektor/lektor/actions?query=workflow%3A%22Tests+master%22)

[![Code Coverage](https://codecov.io/gh/lektor/lektor/branch/master/graph/badge.svg)](https://codecov.io/gh/lektor/lektor)

[![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)

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 sourcecode 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, pip, npm, and pre-commit

installed):

```bash

$ git clone https://github.com/lektor/lektor

$ cd lektor

$ python -m venv _venv

$ . _venv/bin/activate

# pip>=21.3 is required for PEP 610 support

$ pip install -U "pip>=21.3"

$ pip install --editable .

# If you plan on committing:

$ pre-commit 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 test suite (you'll need tox installed):

```sh

$ tox

```