Pelican Notes

1. About

Pelican is a static site generator, written in Python.

2. Installation

  • Follow this doc.

  • Pelican is best installed as a self contained Python virtual environment.

    1. Create a Python virtual environment

      1. Launch VSC

      2. Open a terminal window

      3. Execute the following to create the venv in a folder named pelican:

        py -3 -m venv ./pelican

      4. CD into the new folder:

        cd ./pelican

      5. Activate:

        ./scripts/activate

    2. Install Pelican

      1. Install

        python -m pip install pelican[asciidoc]

      2. Confirm

        pelican --version

3. Create a Skeleton Project

  1. CD into the pelican folder:

    cd ./pelican

  2. Activate:

    ./scripts/activate

  3. Create project

    pelican-quickstart --path ./quickstart
    America/New_York

  4. Add Content

    1. Create a Pages folder in quickstart\content folder

    2. Author .adoc content in the Pages folder.

3.1. Publish

  1. Run

    pelican ./quickstart/content/ [-s path/to/your/settings.py]

4. Upgrades

  1. CD into the pelican folder:

    cd ./pelican

  2. Activate:

    ./scripts/activate

  3. Run upgrade:

    python -m pip install --upgrade pelican