Skip to content

Documentation for pelicanconf.yaml is scattered around and incomplete #90

@sebbASF

Description

@sebbASF

There does not appear to be a definitive document that describes the contents of pelicanconf.yaml.
There are several partial documents, but these are not complete:

Note that neither of them describe what the site/index entry is for.
Nor is the new postrun feature documented.

Given that the file is processed by buildsite.py in this repo, it would seem sensible to document the syntax here.
For example by creating a same yaml file with all the possible entries.
This could even be used in unit tests.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingdocumentationImprovements or additions to documentation

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions