When you start your first Lektor project it's important to understand how data is structured on the file system. A Lektor project is a folder on the file system with a project file and a well defined structure.
The most basic layout looks like this:
There are a few more folders that play a role and plugins can add even more.
The project file holds the main configuration of the project and is used to
identify the project for the user interface. The name does not matter but
it needs to have the
.lektorproject extension. For more information about
that see Project File.
The content folder is named
content and contains all the sources that are
built into the final project. Each folder within corresponds to a record
and the data of it is stored in the file by the name
which is a Lektor content file. All other files are considered attachments.
Here is a basic example layout to get an idea how this can look like:
The content folder is explained in detail in Content.
This is the bread and butter of what makes Lektor powerful. The models define
exactly how the data from the content folder should be processed. The
folder contains a list of INI files that each correspond to a single model.
For more information about this refer to the Data Modelling documentation.
Each model corresponds to a template from the
templates folder. So if you have a
page the file named
page.html from the templates folder will then
be used to render it.
Whatever is stored in the
assets folder is copied over verbatim to the final
result. So if you put a folder named
css in there with all your static CSS
files they will appear as such in the final output.
This folder is not just useful for static files that are stylesheets or
scripts, but because it overlays the entire website you can also use it to
store things such as
flowblocks folder contains models for blocks that are used by the
Flow System. Flow blocks split a part of a page into
smaller pieces so those could be individually designed. They work similar to models
but are contained within a field of a model.
For local plugin development the
packages/ folder can be used. Any plugin
stored in there is automatically activated in the system.
This folder (
configs/) contains plugin specific config files. All the
files in there are named
Lektor also supports Data Bags which go into a
databags/. These are files with some general information
that can be accessed from templates. For instance you could store menus and
navigations there, API keys and much more. This is generally just information
you want to access from different places and maybe not keep in templates directly.